From 669956849aa7c5f97c0b7fde16a871e933f0f019 Mon Sep 17 00:00:00 2001 From: Bojidar Marinov Date: Wed, 29 Mar 2017 22:27:59 +0300 Subject: [PATCH] Update classes.xml to master version, add a small feature to doc_status --- doc/base/classes.xml | 18945 ++++++++++++++++++++------------------ doc/tools/doc_status.py | 15 +- 2 files changed, 9797 insertions(+), 9163 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 3881197ec9..f3d73deaf0 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,5 @@ - + Built-in GDScript functions. @@ -23,6 +23,16 @@ Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. + + + + + + + + + + @@ -82,7 +92,7 @@ - + Decode a byte array back to a value. @@ -97,6 +107,14 @@ Ceiling (rounds up to nearest integer). + + + + + + + + @@ -364,6 +382,15 @@ Return the nearest larger power of 2 for an integer. + + + + + + + Parse json text to a Variant (use [method typeof] to check if it is what you expect). + + @@ -608,6 +635,15 @@ Hyperbolic tangent. + + + + + + + Convert a Variant to json text. + + @@ -625,8 +661,16 @@ Return the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. + + + + + + + + - + @@ -669,6 +713,10 @@ Constant that represents how many times the diameter of a circumference fits around its perimeter. + + + + @@ -682,79 +730,52 @@ - + [AudioServer] singleton - - [AudioServer] singleton + - + + + [Geometry] singleton - - [Globals] singleton + - + [IP] singleton - + [Input] singleton - + [InputMap] singleton - + [Marshalls] singleton - + [OS] singleton - - [PhysicsServer] singleton - - - [Physics2DServer] singleton - - - [PathRemap] singleton - - + [Performance] singleton - + [Physics2DServer] singleton - + [PhysicsServer] singleton - + [ResourceLoader] singleton - + [ResourceSaver] singleton - - [SpatialSoundServer] singleton - - - [SpatialSound2DServer] singleton - - - [SpatialSound2DServer] singleton - - - [SpatialSoundServer] singleton - - + [TranslationServer] singleton - - [TranslationServer] singleton - - - [VisualServer] singleton - - + [VisualServer] singleton @@ -1491,67 +1512,55 @@ - Joystick Button 0 + Joypad Button 0 - Joystick Button 1 + Joypad Button 1 - Joystick Button 2 + Joypad Button 2 - Joystick Button 3 + Joypad Button 3 - Joystick Button 4 + Joypad Button 4 - Joystick Button 5 + Joypad Button 5 - Joystick Button 6 + Joypad Button 6 - Joystick Button 7 + Joypad Button 7 - Joystick Button 8 + Joypad Button 8 - Joystick Button 9 + Joypad Button 9 - Joystick Button 10 + Joypad Button 10 - Joystick Button 11 + Joypad Button 11 - Joystick Button 12 + Joypad Button 12 - Joystick Button 13 + Joypad Button 13 - Joystick Button 14 + Joypad Button 14 - Joystick Button 15 + Joypad Button 15 - Joystick Button 16 - - - Super Nintendo Entertaiment System controller A button - - - Super Nintendo Entertaiment System controller B button - - - Super Nintendo Entertaiment System controller X button - - - Super Nintendo Entertaiment System controller Y button + Joypad Button 16 DUALSHOCK circle button @@ -1565,18 +1574,6 @@ DUALSHOCK triangle button - - SEGA controller B button - - - SEGA controller A button - - - SEGA controller X button - - - SEGA controller Y button - XBOX controller B button @@ -1598,80 +1595,76 @@ - Joystick Button Select + Joypad Button Select - Joystick Button Start + Joypad Button Start - Joystick DPad Up + Joypad DPad Up - Joystick DPad Down + Joypad DPad Down - Joystick DPad Left + Joypad DPad Left - Joystick DPad Right + Joypad DPad Right - Joystick Left Shoulder Button + Joypad Left Shoulder Button - Joystick Left Trigger + Joypad Left Trigger - Joystick Left Stick Click + Joypad Left Stick Click - Joystick Right Shoulder Button + Joypad Right Shoulder Button - Joystick Right Trigger + Joypad Right Trigger - Joystick Right Stick Click + Joypad Right Stick Click - Joystick Left Stick Horizontal Axis + Joypad Left Stick Horizontal Axis - Joystick Left Stick Vertical Axis + Joypad Left Stick Vertical Axis - Joystick Right Stick Horizontal Axis + Joypad Right Stick Horizontal Axis - Joystick Right Stick Vertical Axis + Joypad Right Stick Vertical Axis - Joystick Left Trigger Analog Axis + Joypad Left Trigger Analog Axis - Joystick Right Trigger Analog Axis + Joypad Right Trigger Analog Axis - - Joystick Left Stick Horizontal Axis + + Joypad Left Stick Horizontal Axis - - Joystick Left Stick Vertical Axis + + Joypad Left Stick Vertical Axis - - Joystick Right Stick Horizontal Axis + + Joypad Right Stick Horizontal Axis - - Joystick Right Stick Vertical Axis - - - - + + Joypad Right Stick Vertical Axis @@ -1723,7 +1716,7 @@ - + @@ -1784,29 +1777,34 @@ Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers. - - Property hint for a bitmask description that covers all 32 bits. Valid only for integers. + - + + + + + + + String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "*.doc". - + String property is a directory (so pop up a file dialog when edited). - + - + - + String property is a resource, so open the resource popup menu when edited. - + - + - + - + Property will be used as storage (default). @@ -1824,7 +1822,7 @@ - + @@ -1885,8 +1883,8 @@ Variable is of type [Vector3]. - - Variable is of type [Matrix32]. + + Variable is of type [Transform2D]. Variable is of type [Plane]. @@ -1894,11 +1892,11 @@ Variable is of type [Quat]. - - Variable is of type [AABB]. + + Variable is of type [Rect3]. - - Variable is of type [Matrix3]. + + Variable is of type [Basis]. Variable is of type [Transform]. @@ -1955,204 +1953,6 @@ - - - Axis-Aligned Bounding Box. - - - AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. - - - - - - - - - - - Optional constructor, accepts position and size. - - - - - - - - - Return true if this [AABB] completely encloses another one. - - - - - - - - - Return this [AABB] expanded to include a given point. - - - - - - - Get the area of the [AABB]. - - - - - - - - - Get the position of the 8 endpoints of the [AABB] in space. - - - - - - - Return the normalized longest axis of the [AABB]. - - - - - - - Return the index of the longest axis of the [AABB] (according to [Vector3]::AXIS* enum). - - - - - - - Return the scalar length of the longest axis of the [AABB]. - - - - - - - Return the normalized shortest axis of the [AABB]. - - - - - - - Return the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum). - - - - - - - Return the scalar length of the shortest axis of the [AABB]. - - - - - - - - - Return the support point in a given direction. This is useful for collision detection algorithms. - - - - - - - - - Return a copy of the [AABB] grown a given amount of units towards all the sides. - - - - - - - Return true if the [AABB] is flat or empty. - - - - - - - Return true if the [AABB] is empty. - - - - - - - - - Return true if the [AABB] contains a point. - - - - - - - - - Return the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure. - - - - - - - - - Return true if the [AABB] overlaps with another. - - - - - - - - - Return true if the [AABB] is at both sides of a plane. - - - - - - - - - - - Return true if the [AABB] intersects the line segment between from and to - - - - - - - - - Combine this [AABB] with another, a larger one is returned that contains both. - - - - - - Ending corner. - - - Position (starting corner). - - - Size from position to end. - - - - - @@ -2222,7 +2022,7 @@ - + @@ -2232,7 +2032,7 @@ - + @@ -2335,12 +2135,6 @@ Register a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. - - - - - - @@ -2356,6 +2150,12 @@ + + + + + + @@ -2395,13 +2195,6 @@ Return the visible frame index. - - - - - Return the color modulation for this sprite. - - @@ -2486,13 +2279,6 @@ Set the visible sprite frame index (from the list of frames inside the [SpriteFrames] resource). - - - - - Change the color modulation (multiplication) for this sprite. - - @@ -2513,17 +2299,35 @@ + + + + + + + + + + + + + + + + + + + + + Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn, before looping. + + Emitted when frame is changed. - - - Emitted when the animation is finished (when it plays the last frame). If the animation is looping, this signal is emitted every time the last frame is drawn, before looping. - - @@ -2596,6 +2400,16 @@ + + + + + + + + + + @@ -2669,7 +2483,7 @@ - + @@ -2744,6 +2558,14 @@ Find the key index by time in a given track. Optionally, only find it if the exact time is given. + + + + + + + + @@ -2874,6 +2696,14 @@ Set the given track as imported or not. + + + + + + + + @@ -2943,7 +2773,7 @@ - + @@ -3070,7 +2900,7 @@ - + Get the list of names of the animations stored in the player. @@ -3143,7 +2973,7 @@ Return path to root node (see [method set_root]). - + @@ -3280,7 +3110,7 @@ AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed. - + @@ -3300,6 +3130,14 @@ + + + + + + + + @@ -3310,6 +3148,13 @@ If the currently being played animation changes, this signal will notify of such change. + + + + + Notifies when an animation finished playing. + + @@ -3317,11 +3162,6 @@ Notifies when an animation starts playing. - - - Notifies when an animation finished playing. - - @@ -3398,6 +3238,18 @@ + + + + + + + + + + + + @@ -3456,7 +3308,7 @@ - + @@ -3468,7 +3320,7 @@ - + @@ -3495,7 +3347,7 @@ - + @@ -3506,18 +3358,6 @@ - - - - - - - - - - - - @@ -3848,6 +3688,10 @@ + + + + @@ -3988,7 +3832,7 @@ Return whether this area can be detected by other, monitoring, areas. - + @@ -4037,13 +3881,6 @@ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. - - - - - Set whether this area can detect bodies/areas entering/exiting it. - - @@ -4107,6 +3944,13 @@ Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. + + + + + Set whether this area can detect bodies/areas entering/exiting it. + + @@ -4128,15 +3972,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + - + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. - + + + + + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + + + @@ -4149,14 +4026,7 @@ This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. - - - - - This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. - - - + @@ -4169,14 +4039,21 @@ This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. - + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. - + + + + + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. + + + @@ -4189,14 +4066,7 @@ This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. - - - - - This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. - - - + @@ -4330,7 +4200,7 @@ Return whether this area can be detected by other, monitoring, areas. - + @@ -4379,13 +4249,6 @@ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. - - - - - Set whether this area can detect bodies/areas entering/exiting it. - - @@ -4449,6 +4312,13 @@ Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. + + + + + Set whether this area can detect bodies/areas entering/exiting it. + + @@ -4470,15 +4340,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + - + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. - + + + + + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. + + + @@ -4491,14 +4394,7 @@ This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. - - - - - This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. - - - + @@ -4511,14 +4407,21 @@ This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. - + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. - + + + + + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. + + + @@ -4531,14 +4434,7 @@ This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. - - - - - This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. - - - + @@ -4566,64 +4462,64 @@ - + - Construct an array from a [RawArray]. + Construct an array from a [PoolByteArray]. - + - Construct an array from a [RawArray]. + Construct an array from a [PoolByteArray]. - + - Construct an array from a [RawArray]. + Construct an array from a [PoolByteArray]. - + - Construct an array from a [RawArray]. + Construct an array from a [PoolStringArray]. - + - Construct an array from a [RawArray]. + Construct an array from a [PoolRealArray]. - + - Construct an array from a [RawArray]. + Construct an array from a [PoolByteArray]. - + - Construct an array from a [RawArray]. + Construct an array from a [PoolByteArray]. @@ -4633,6 +4529,11 @@ Append an element at the end of the array (alias of [method push_back]). + + + Returns the last element of the array if the array is not empty (size>0). + + Clear the array (resize to 0). @@ -4661,20 +4562,6 @@ Remove the first occurrence of a value from the array. - - - - - Returns the first element of the array if the array is not empty (size>0). - - - - - - - Returns the last element of the array if the array is not empty (size>0). - - @@ -4695,6 +4582,11 @@ Searches the array in reverse order for a value and returns its index or -1 if not found. + + + Returns the first element of the array if the array is not empty (size>0). + + @@ -4725,13 +4617,6 @@ Reverse the order of the elements in the array (so first element will now be the last). - - - - - Get whether this is a shared array instance. - - Remove the last element of the array. @@ -4849,6 +4734,14 @@ + + + + + + + + @@ -4858,6 +4751,1328 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Server interface for low level audio access. @@ -4866,487 +6081,261 @@ AudioServer is a low level server interface for audio access. It is in charge of creating sample data (playable audio) as well as its playback via a voice interface. - - + + - Free a [RID] resource. - - - - - Return the global scale for event-based stream playback. - - - - - - - Return the global scale for all voices. - - - - - - - Return the global scale for stream playback. - - - - - - + + - + - + - Create an audio sample, return a [RID] referencing it. The sample will be created with a given format (from the SAMPLE_FORMAT_* enum), a total length (in samples, not bytes), in either stereo or mono. - Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes. - - + + - + + + + + + + + + + + + + + + - Return the sample data as an array of bytes. The length will be the expected length in bytes. - + + + + + + + + + + + - + - Return the description of an audio sample. Mainly used for organization. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - Return the format of the audio sample, in the form of the SAMPLE_FORMAT_* enum. - - - - - - - Return the length in samples (not bytes) of the audio sample. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes. - - - - - - - - - Return the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. - - - - - - - - - Return the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. - - - - - - - - - Return the loop format for a sample, as a value from the SAMPLE_LOOP_* enum. - - - - - - - - - Return the mix rate of the given sample. - - - + - + - Return whether the sample is stereo (2 channels). - - - - - - - Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows: - Get the sample length ([method sample_get_length]). - If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2. - If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. - If the sample is stereo ([method sample_is_stereo]), multiply it by 2. - - - - - - - - - Set the description of an audio sample. Mainly used for organization. - - - - - - - - - Set the initial loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. - - - - - - - - - Set the final loop point of a sample. Only has effect if sample loop is enabled. See [method sample_set_loop_format]. - - - - - - - - - Set the loop format for a sample from the SAMPLE_LOOP_* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms. - - - - - - - - - Change the default mix rate of a given sample. - - - - - - - - - Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced. - For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by [method sample_get_length]. - Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data. - - - - - - - Set global scale for event-based stream ([EventStream]) playback. Default is 1.0. - - - - - - - Set global scale for all voices (not including streams). Default is 1.0. - - - - - - - Set global scale for stream playback. Default is 1.0. - - - - - - - Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See [method sample_create]. - - - - - - - - - Return the current chorus send for a given voice (0 to 1). - - - - - - - - - Return the current filter cutoff (in hz) for a given voice. - - - - - - - - - Return the current filter resonance for a given voice. - - - - - - - - - Return the current selected filter type for a given voice, from the FILTER_* enum. - - - - - - - - - Return the current mix rate for a given voice. - - - - - - - - - Return the current pan for a given voice (-1 to +1 range). - - - - - - - - - Return the current pan depth for a given voice (-1 to +1 range). - - - - - - - - - Return the current pan height for a given voice (-1 to +1 range). - - - - - - - - - Return the current reverb send for a given voice (0 to 1). - - - - - - - - - Return the current reverb type for a given voice from the REVERB_* enum. - - - - - - - - - Return the current volume for a given voice. - - - + - + + + - Return whether the current voice is positional. See [method voice_set_positional]. - - - - + + + + - Start playback of a given voice using a given sample. If the voice was already playing it will be restarted. - - - - + + + + - Set chorus send post processing for the voice (from 0 to 1). - - - - - - - - - - - + - Set a resonant filter post processing for the voice. Filter type is a value from the FILTER_* enum. - - + + - + - Set a different playback mix rate for the given voice. - - - - - - - - + + - Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range. - - + + - + - Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding. - - + + - - - + - Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB_* enum. - - - - + + - Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default. - - + + + + + + - Stop a given voice. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - Sample format is 8 bits, signed. - - - Sample format is 16 bits, little-endian, signed. - - - Sample format is IMA-ADPCM compressed. - - - Sample does not loop. - - - Sample loops in forward mode. - - - Sample loops in a bidirectional way. - - - Filter is disabled. - - - Filter is a resonant lowpass. - - - Filter is a resonant bandpass. - - - Filter is a resonant highpass. - - - Filter is a notch (band reject). - - - Filter is a bandlimit (resonance used as highpass). - - - Small reverb room (closet, bathroom, etc). - - - Medium reverb room (living room) - - - Large reverb room (warehouse). - - - Large reverb room with long decay. - - - - - - Software implementation of [AudioServer]. - - - This is a software audio server. It does not use any kind of hardware acceleration. - This class does not expose any new method. - - - + + + + + + @@ -5362,18 +6351,6 @@ - - - MusePack audio stream driver. - - - MusePack audio stream driver. - - - - - - OGG Vorbis audio stream driver. @@ -5382,19 +6359,37 @@ OGG Vorbis audio stream driver. + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - Opus Codec audio stream driver. - - - Opus Codec audio stream driver. - - - + + + + + + @@ -5404,25 +6399,41 @@ - + + + + + + + + + + + + + + + + + - - - - - - - + - + + + + + + + @@ -5434,47 +6445,71 @@ - - - - - - - + - - - - - - - - + + - - + + - - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -5515,6 +6550,12 @@ + + + + + + Disables the buffering mode. This means the BackBufferCopy node will directly use the portion of screen it covers. @@ -5527,353 +6568,49 @@ - + - - - - - + - + - - - + - - - + - - - + - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + @@ -5883,54 +6620,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Provides a base class for different kinds of buttons. @@ -5951,11 +6640,17 @@ Called when button is toggled (only if toggle_mode is active). - - + + + + + Return the current mode of action (see [method set_action_mode]) (one of the ACTION_MODE_* constants). + + + + - Return the state of the click_on_press property (see [method set_click_on_press]). @@ -6006,11 +6701,17 @@ Return the toggle_mode property (see [method set_toggle_mode]). - - + + + + + Set the current mode of action, determining when the button is considered clicked (see the ACTION_MODE_* constants). + + + + - Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). @@ -6048,6 +6749,22 @@ + + + + + + + + + + + + + + + + @@ -6064,11 +6781,6 @@ This signal is emitted every time the button is toggled or pressed (i.e. activated, so on [code]button_down[/code] if "Click on press" is active and on [code]button_up[/code] otherwise). - - - Emitted when the button was released. This is only emitted by non-toggle buttons and if "Click on press" is active. - - @@ -6090,6 +6802,181 @@ The state of buttons are disabled. + + Require just a press to consider the button clicked. + + + Require a press and a subsequent release before considering the button clicked. + + + + + + 3x3 matrix datatype. + + + 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized. Almost always used as orthogonal basis for a [Transform]. + For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). + + + + + + + + + Create a rotation matrix from the given quaternion. + + + + + + + + + + + Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector. + + + + + + + + + + + + + Create a matrix from 3 axis vectors. + + + + + + + Return the determinant of the matrix. + + + + + + + Return Euler angles (in the XYZ convention: first Z, then Y, and X last) from the matrix. Returned vector contains the rotation angles in the format (third,second,first). + This function only works if the matrix represents a proper rotation. + + + + + + + This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code. + + + + + + + Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. + + + + + + + Return the inverse of the matrix. + + + + + + + Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. + + + + + + + + + + + Introduce an additional rotation around the given axis by phi. Only relevant when the matrix is being used as a part of [Transform]. The axis must be a normalized vector. + + + + + + + + + Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of [Transform]. + + + + + + + + + Transposed dot product with the x axis of the matrix. + + + + + + + + + Transposed dot product with the y axis of the matrix. + + + + + + + + + Transposed dot product with the z axis of the matrix. + + + + + + + Return the transposed version of the matrix. + + + + + + + + + Return a vector transformed (multiplied) by the matrix and return it. + + + + + + + + + Return a vector transformed (multiplied) by the transposed matrix and return it. Note that this is a multiplication by inverse only when the matrix represents a rotation-reflection. + + + + + + + + + + + + @@ -6147,6 +7034,10 @@ + + + + @@ -6271,6 +7162,22 @@ + + + + + + + + + + + + + + + + @@ -6282,6 +7189,18 @@ This node must be the child of a [Skeleton] node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone. + + + + + + + + + + + + @@ -6317,6 +7236,10 @@ + + + + Align children with beginning of the container. @@ -6352,6 +7275,10 @@ + + + + @@ -6434,6 +7361,18 @@ + + + + + + + + + + + + Align the text to the left. @@ -6482,8 +7421,10 @@ + + - Append a new button to the array, with the specified text. + Append a new button to the array, with the specified text and tooltip. @@ -6491,8 +7432,10 @@ + + - Append a new button to the array, with the specified icon and text. + Append a new button to the array, with the specified icon, text and tooltip. @@ -6532,6 +7475,15 @@ Return the text of the specified button. + + + + + + + Return the tooltip of the specified button. + + @@ -6546,6 +7498,12 @@ Return the index of the currently selected button in the array. + + + + + + @@ -6564,6 +7522,21 @@ Define the text of the specified button. + + + + + + + Define the tooltip of the specified button. + + + + + + + + @@ -6572,6 +7545,10 @@ + + + + @@ -6599,7 +7576,7 @@ - + Group of Buttons. @@ -6607,41 +7584,13 @@ Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed. - - - - - Return the list of all the buttons in the group. - - - - - - - Return the focused button. - - - + Return the pressed button. - - - - - Return the index of the pressed button (by tree order). - - - - - - - Set the button to be pressed. - - @@ -6669,6 +7618,12 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. + + + + + + @@ -6681,6 +7636,12 @@ + + + + + + @@ -6699,8 +7660,8 @@ - - + + @@ -6771,12 +7732,24 @@ Return a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking. + + + + + + + + + + + + @@ -6805,8 +7778,8 @@ Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. - - + + @@ -7073,6 +8046,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -7126,11 +8137,11 @@ - + - + @@ -7154,11 +8165,11 @@ - + - + - + @@ -7167,11 +8178,11 @@ - + - + - + @@ -7202,7 +8213,7 @@ - + @@ -7299,13 +8310,6 @@ Set the transform state of this CanvasItem. For [Node2D], this is an [Array] with (in order) a [Vector2] for position, a float for rotation and another [Vector2] for scale. For [Control] this is a [Rect2] with the position and size. - - - - - Return the current blending mode from enum BLEND_MODE_*. - - @@ -7321,7 +8325,7 @@ - + Get the transform matrix of this item's canvas. @@ -7335,14 +8339,14 @@ - + Get the global transform matrix of this item. - + Get the global transform matrix of this item in relation to the canvas. @@ -7383,22 +8387,22 @@ Get the material of this item. - - + + - Return the canvas item opacity. This affects the canvas item and all the children. + Get the modulate of the CanvasItem, which affects children items too. - - + + - Return the canvas item self-opacity. + Get the self-modulate of the CanvasItem. - + Get the transform matrix of this item. @@ -7419,7 +8423,7 @@ - + Get this item's transform in relation to the viewport. @@ -7444,11 +8448,10 @@ Return whether the item is drawn behind its parent. - + - Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden ([method hide] called) the function will return false. @@ -7458,6 +8461,12 @@ Return if set as toplevel. See [method set_as_toplevel]. + + + + + + @@ -7465,6 +8474,12 @@ Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden. + + + + + + @@ -7489,13 +8504,6 @@ Set as top level. This means that it will not inherit transform from parent canvas items. - - - - - Set the blending mode from enum BLEND_MODE_*. - - @@ -7503,13 +8511,6 @@ Set whether the canvas item is drawn behind its parent. - - - - - Set whether this item should be hidden or not. Note that no matter what is set here this item won't be shown if its parent or grandparents nodes are also hidden. A hidden CanvasItem make all children hidden too. - - @@ -7524,18 +8525,30 @@ Set the material of this item. - - + + - Set canvas item opacity. This will affect the canvas item and all the children. + Set the modulate of the CanvasItem. This [i]affects[/i] the modulation of children items. - - + + - Set canvas item self-opacity. This does not affect the opacity of children items. + + + + + + + + + + + + + Set the self-modulate of the CanvasItem. This does not affect the modulation of children items. @@ -7545,6 +8558,14 @@ Set whether or not this item should use its parent's material. + + + + + Set whether this item should be visible or not. + Note that a hidden CanvasItem will make all children hidden too, so no matter what is set here this item won't be shown if its parent or grandparents nodes are hidden. + + Show the CanvasItem currently hidden. @@ -7556,6 +8577,24 @@ + + + + + + + + + + + + + + + + + + @@ -7611,7 +8650,7 @@ - + @@ -7629,12 +8668,6 @@ - - - - - - @@ -7649,20 +8682,8 @@ - - - - - - - - - - - - @@ -7675,16 +8696,6 @@ - - - - - - - - - - Canvas Item layer. @@ -7735,7 +8746,7 @@ - + Return the base transform for this layer. @@ -7790,13 +8801,23 @@ - + Set the base transform for this layer. + + + + + + + + + + @@ -7823,6 +8844,10 @@ + + + + @@ -7863,6 +8888,12 @@ + + + + + + @@ -7903,6 +8934,12 @@ + + + + + + @@ -7929,6 +8966,10 @@ + + + + @@ -8043,6 +9084,184 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -8169,6 +9388,12 @@ + + + + + + @@ -8184,11 +9409,11 @@ - + - + @@ -8218,7 +9443,7 @@ - + Add a [Shape2D] to the collision body, with a given custom transform. @@ -8253,7 +9478,7 @@ - + @@ -8312,13 +9537,17 @@ - + Change the shape transform in the collision body. + + + + @@ -8331,12 +9560,12 @@ This signal triggers when an input event fires over a shape. The first parameter is the viewport where the event took place. The second holds the input event received, and the third the shape of this object where it happened. - + This event fires only once when the mouse pointer enters any shape of this object. - + This event fires only once when the mouse pointer exits all shapes of this object. @@ -8376,7 +9605,7 @@ - + @@ -8394,12 +9623,22 @@ - + + + + + + + + + + + @@ -8435,7 +9674,7 @@ - + Return the list of points that define the polygon. @@ -8456,7 +9695,7 @@ - + Set the array of points forming the polygon. @@ -8471,6 +9710,16 @@ + + + + + + + + + + @@ -8521,6 +9770,14 @@ + + + + + + + + @@ -8568,6 +9825,14 @@ + + + + + + + + @@ -8691,153 +9956,43 @@ - + Alpha (0 to 1) - + Alpha (0 to 255) - + Blue (0 to 1) - + Blue (0 to 255) - + Green (0 to 1) - + Green (0 to 255) - + Hue (0 to 1) - + Red (0 to 1) - + Red (0 to 255) - + Saturation (0 to 1) - + Value (0 to 1) - - - Array of Colors - - - Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. - - - - - - - - - Create from a generic array. - - - - - - - Append an element at the end of the array (alias of [method push_back]). - - - - - - - Append an [ColorArray] at the end of this array. - - - - - - - - - - - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - - - - - Reverse the order of the elements in the array (so first element will now be the last). - - - - - - - Append a value to the array. - - - - - - - Remove an element from the array by index. - - - - - - - Set the size of the [ColorArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - - - - - - - - - Change the [Color] at the given index. - - - - - - - Return the array size. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Color picker control. @@ -8853,11 +10008,11 @@ Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. - + - Return the current (edited) color. + Gets the current color. @@ -8874,13 +10029,6 @@ Returns whether this color picker is in raw mode or not, raw mode will allow the color R, G, B component values to go beyond 1, you have to consider that the max value for color components is 1, going beyond that value will not have effect in the color, but can be used for special operations that require it (like tinting without darkening or rendering sprites in HDR). - - - - - Select the current color. - - @@ -8888,6 +10036,13 @@ Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color. + + + + + Select the current color. + + @@ -8910,6 +10065,10 @@ + + + + @@ -8932,11 +10091,10 @@ Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility - + - Gets the current color @@ -8952,13 +10110,6 @@ See [method ColorPicker.is_edit_alpha] - - - - - Sets the current color - - @@ -8966,7 +10117,19 @@ See [method ColorPicker.set_edit_alpha] + + + + + + + + + + + + @@ -9030,7 +10193,7 @@ - + Returns the colors in the ramp @@ -9046,7 +10209,7 @@ - + Returns the offsets for the colors in this ramp @@ -9085,7 +10248,7 @@ - + Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements. @@ -9101,13 +10264,45 @@ - + Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accommodate the new elements, all new colors will be black by default. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -9120,14 +10315,14 @@ - + Return the faces (an array of triangles). - + Set the faces (an array of triangles). @@ -9147,20 +10342,24 @@ - + Return the array of segments. - + Set the array of segments. + + + + @@ -9187,6 +10386,18 @@ + + + + + + + + + + + + @@ -9223,8 +10434,14 @@ [/codeblock] + + + + + + - + @@ -9233,7 +10450,7 @@ - + Return an array of all defined section identifiers. @@ -9376,7 +10593,14 @@ Finally, controls are skinned according to a [Theme]. Setting a [Theme] on a control will propagate all the skinning down the tree. Optionally, skinning can be overridden per each control by calling the add_*_override functions, or from the editor. - + + + + + Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + + + @@ -9624,11 +10848,11 @@ Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. - - + + - Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + Return when the control is ignoring mouse events (even touchpad events send mouse events). @@ -9811,8 +11035,6 @@ - - @@ -9836,14 +11058,7 @@ - - - - - Return if the control is ignoring mouse events (even touchpad events send mouse events). - - - + @@ -9895,6 +11110,12 @@ Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + + + + + + @@ -9957,13 +11178,6 @@ Hint for containers, set horizontal positioning flags. - - - - - Ignore mouse events on this control (even touchpad events send mouse events). - - @@ -9973,6 +11187,13 @@ Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Offset value being set depends on the anchor mode. + + + + + Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER_* constants) + + @@ -10005,12 +11226,6 @@ Changes MARGIN_RIGHT and MARGIN_BOTTOM to fit a given size. This is a helper (see [method set_margin]). - - - - - - @@ -10053,18 +11268,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + Emitted when keyboard focus is gained. - + Emitted when the keyboard focus is lost. - + @@ -10076,16 +11341,16 @@ Emitted when the minimum size of the control changed. - + - + Emitted when the mouse enters the control area. - + Emitted when the mouse left the control area. @@ -10108,10 +11373,7 @@ X is relative to -MARGIN_RIGHT, Y is relative to -MARGIN_BOTTOM. - - X and Y are a ratio (0 to 1) relative to the parent size 0 is left/top, 1 is right/bottom. - - + Control can't acquire focus. @@ -10177,12 +11439,18 @@ - + - + + + + + + + @@ -10194,18 +11462,22 @@ - + - + + + + + @@ -10219,27 +11491,31 @@ - + Return a list of points in either clockwise or counter clockwise order, forming a convex polygon. - + Currently, this method does nothing. - + Set a list of points in either clockwise or counter clockwise order, forming a convex polygon. + + + + @@ -10267,12 +11543,6 @@ - - - - - - @@ -10372,6 +11642,10 @@ If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list. + + + + @@ -10387,10 +11661,10 @@ - + - Returns the cache of points as a [Vector2Array]. + Returns the cache of points as a [PoolVector2Array]. @@ -10503,7 +11777,7 @@ - + @@ -10517,6 +11791,12 @@ + + + + + + @@ -10543,6 +11823,10 @@ If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= [method get_point_count]), the point will be appended at the end of the point list. + + + + @@ -10558,14 +11842,14 @@ - + - Returns the cache of points as a [Vector3Array]. + Returns the cache of points as a [PoolVector3Array]. - + Returns the cache of tilts as a [RealArray]. @@ -10700,7 +11984,7 @@ - + @@ -10714,6 +11998,12 @@ + + + + + + @@ -10782,6 +12072,16 @@ + + + + + + + + + + @@ -10844,15 +12144,6 @@ Return the list of keys in the [Dictionary]. - - - - - - - Parse json text to the dictionary. Return OK when successed or the error code when failed. - - @@ -10860,13 +12151,6 @@ Return the size of the dictionary (in pairs). - - - - - Return the dictionary as json text. - - @@ -10892,10 +12176,14 @@ - - + + - + + + + + @@ -10906,29 +12194,29 @@ - - - - - - - - + + + + + + + + + + + + + + + + - + - - - - - - - - - + @@ -11010,6 +12298,12 @@ Return the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). + + + + + + @@ -11030,7 +12324,8 @@ - Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code]). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case). + Return the next element (file or directory) in the current directory (including [code].[/code] and [code]..[/code], unless [code]skip_navigational[/code] was given to [method list_dir_begin]). + The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. [method list_dir_end] would not be mandatory in such a case). @@ -11041,11 +12336,16 @@ - + + + + + Initialise the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. - Return true if the stream could not be initialised. + If you pass [code]skip_navigational[/code], then [code].[/code] and [code]..[/code] would be filtered out. + If you pass [code]skip_hidden[/code], then hidden files would be filtered out. @@ -11214,6 +12514,24 @@ + + + + + + + + + + + + + + + + + + @@ -11244,32 +12562,10 @@ - - - - - - Editor plugin to control the export process. - - - This plugin is added into EditorImportExport and allows to modify the behavior of the export process for individual files. - - - - - - - - - - - This function is called for each file exported and depending from the return value one of many things might happen. - 1) If returned value is null, the file is exported as is. - 2) If the returned value is a RawAray (array of bytes), the content of that array becomes the new file being exported. - 3) If the file must also change its name when exported, then a [Dictionary] must be returned with two fields: 'name' with the new filename and 'data' with a [RawArray] containing the raw contents of the file. Even if the name is changed, the run-time will redirect the old file to the new file automatically when accessed. - - - + + + + @@ -11410,7 +12706,7 @@ - + @@ -11459,7 +12755,7 @@ Get the root directory object. - + @@ -11601,113 +12897,6 @@ - - - - - - - - - - - - - - - Import plugin for editor - - - Import plugins make it easy to handle importing of external assets into a project. They way they work is not that obvious though, so please make sure to read the documentation, tutorials and examples. - - - - - - - - - - - - - - - - - Generally, files that are imported stay the same when exported. The only exception is in some cases when the file must be re-imported for different platforms (ie. texture compression). - If you want to customize the export process, it's recommended to use [method EditorExportPlugin.custom_export] instead. - - - - - - - - - - - - - - - Get the name of the import plugin, which will be used to identify content imported by this plugin. Try to use lowercase and underscores if possible. - - - - - - - Visible name for this plugin, which will be shown on the import menu. - - - - - - - - - - - Perform an import of an external resources into the project. This function is both called on import (from the dialog) or re-import (manual or automatic when external source files changed). - An import process generally works like this: - 1) Check the metadata for source files and options. Metadata is either generated in the import dialog or taken from an existing resource upon reimport. - 2) Perform the import process into a new resource. Some times the resource being re-imported may be already loaded and in use, so checking for this by using [method ResourceLoader.has] is recommended. Otherwise create a new resource. - 3) Set the metadata from the argument into the existing or new resource being created using [method Resource.set_import_metadata]. - 4) Save the resource into 'path' (function argument) - - - - - - - This function is called when either the user chooses to import a resource of this type (Import menu), or when the user chooses to re-import the resource (from filesystem). In the later case, the path for the existing file is supplied in the argument. - If the path is supplied, it is recommended to read the import metadata with [method ResourceLoader.load_import_metadata] and fill in the fields with the values contained there. - The dialog can be shown in any way (just use a ConfirmationDialog and pop it up). Upon confirmation, fill up a ResourceImportMetadata and call the [method EditorImportPlugin.import] function with this information. - - - - - - - - - - - - - - - - - - - - - - - - @@ -11769,19 +12958,12 @@ During run-time, this will be a simple object with a script so this function does not need to be called then. - - + + + + - Add an export plugin. Plugins of this kind can change files being exported. On exit don't forget to call [method remove_export_plugin]. - - - - - - - Add an import plugin. These plugins manage importing external content (from outside the project) into formats the engine can understand. - On exit, don't forget to remove the plugin by calling [method remove_import_plugin] @@ -11811,10 +12993,16 @@ This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. - + + + + + + + - + @@ -11823,7 +13011,7 @@ - + @@ -11831,7 +13019,7 @@ This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas]. - + @@ -11852,7 +13040,7 @@ - + This is for editors that edit script based objects. You can return a list of breakpoints in the format (script:line), for example: res://path_to_script.gd:25 @@ -11872,13 +13060,6 @@ Get the main editor control. Use this as a parent for main screens. - - - - - Tells the editor to handle the edit of the given resource. Ex: If you pass a Script as a argument, the editor will open the scriptEditor. - - @@ -11997,20 +13178,6 @@ Remove a custom type added by [method EditorPlugin.add_custom_type] - - - - - Remove the export plugin, don't forget to call this on exit. - - - - - - - Remove the import plugin, don't forget to call this on exit. - - This method is called after the editor saves the project or when it's closed. It asks the plugin to save edited external scenes/resources. @@ -12182,26 +13349,6 @@ - - - Base script for post-processing scenes being imported. - - - These scripts can modify scenes after being imported by the 3D Scene import option of the Import menu. - - - - - - - This function is called upon import with the imported scene. - Just do any changes desired to the scene and return it. If null is returned, import will fail and throw an error to the user. - - - - - - Simple script to perform changes in the currently edited scene. @@ -12324,7 +13471,7 @@ - + Get the list of favorite directories for this project. @@ -12338,7 +13485,7 @@ - + Get the list of recently visited folders in the file dialog for this project. @@ -12354,14 +13501,14 @@ - + Set the list of favorite directories for this project. - + Set the list of recently visited folders in the file dialog for this project. @@ -12386,7 +13533,7 @@ - + @@ -12399,7 +13546,7 @@ - + @@ -12411,7 +13558,7 @@ - + @@ -12504,23 +13651,141 @@ + + + + + + + + + + + Returns the value of the commandline argument "-level". + + + + + + + Return the total amount of frames drawn. + + + + + + + Returns the frames per second of the running game. + + + + + + + Return the amount of fixed iterations per second (for fixed process and physics). + + + + + + + Return the main loop object (see [MainLoop] and [SceneTree]). + + + + + + + + + + + + + + + + + + + Returns the current engine version information in a Dictionary. + + "major" - Holds the major version number as a String + "minor" - Holds the minor version number as a String + "patch" - Holds the patch version number as a String + "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String + "revision" - Holds the revision (e.g. "custom-build") as a String + "string" - major + minor + patch + status + revision in a single String + + + + + + + Set the amount of fixed iterations per second (for fixed process and physics). + + + + + + + + + + + + + + + + + + - - - + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -12530,396 +13795,810 @@ - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Class for event stream playback. - - - Class for event stream playback. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, or MOD music. - Currently, only MOD, S3M, IT, and XM music is supported. - - - - - - + + - Return the time at which the last note of a given channel in the stream plays. - - - - + + - Return the volume scale for an individual channel of the stream. - - - - - Return the song length. May be in seconds, but depends on the stream type. - - - - - - - Return the number of times the playback has looped. - - - - - - - Return the pitch scale factor for this player. - - - - - - - Return the playback position. May be in seconds, but depends on the stream type. - - - - - - - Return the currently assigned stream. - - - - - - - Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>". - - - - - - - Return the tempo multiplier. - - - - - - - Return the playback volume for this player. - - - - - - - Return the playback volume for this player, in decibels. - - - - - - - Return whether this player will start playing as soon as it enters the scene tree. - - - - - - - Return whether this player will be restart the playback at the end. - - - - - - - Return whether the playback is currently paused. - - - - - - - Return whether this player is playing. - - - - - Play the currently assigned stream. - - - - + + - Set the playback position. May be in seconds, but depends on the stream type. - + + + + + + + - Set whether this player will start playing as soon as it enters the scene tree. - - - - + + - Set the volume scale for an individual channel of the stream, with the same value range as [method set_volume]. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. - Many stream formats are multichannel, so this allows to affect only a part of the music. - + + + + + + + - Set whether the stream will be restarted at the end. - - + + - Pause stream playback. - - + + - Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down. - - + + - Set the [EventStream] this player will play. - - + + - Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch. - - + + - Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference. - The effect of these special values ultimately depends on the low-level implementation of the file format being played. - - + + - Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see [method set_volume]) still apply. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Stop playing. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - Base class for all event-based stream drivers. - - - Base class for all event-based stream drivers. Event streams are music expressed as a series of events (note on, note off, instrument change...), as opposed to audio streams, which are just audio data. Examples of event-based streams are MIDI files, of MOD music. - This class exposes no methods. - - - - - - - - - Driver for MOD playback. - - - This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events occurring at defined moments, instead of a stream of audio samples. - Currently, this driver supports the MOD, S3M, IT, and XM formats. - This class exposes no methods. - This class can return its playback position in seconds, but does not allow to set it, failing with only a console warning. - This class can not return its song length, returning 1.0 when queried. - This class does not limit its volume settings, allowing for overflow/distortion and wave inversion. - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13002,16 +14681,16 @@ - + - Get next len bytes of the file as a [RawArray]. + Get next len bytes of the file as a [PoolByteArray]. - + @@ -13070,6 +14749,14 @@ Return a md5 String representing the file at the given path or an empty [String] on failure. + + + + + + + + @@ -13130,7 +14817,7 @@ - + Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. @@ -13200,7 +14887,7 @@ - + Store the given array of bytes in the file. @@ -13320,7 +15007,7 @@ - + @@ -13380,7 +15067,7 @@ - + @@ -13400,6 +15087,16 @@ + + + + + + + + + + @@ -13416,7 +15113,7 @@ - + Event emitted when the user selects multiple files. @@ -13466,25 +15163,116 @@ FixedSpatialMaterial is a simple type of material [Resource], which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial] for most simple use cases. - - + + - - - + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Return a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13493,139 +15281,511 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - Return the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. + + + + + + - + - Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). - - + + - Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + + - - - - + + + + + + + + + + + + + + - Set a parameter, parameters are defined in the PARAM_* enum. The type of each parameter may change, so it's best to check the enum. - + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Set the texture coordinate mode. Each texture param (from the PARAM_* enum) has one. It defines how the textures are mapped to the object. - + - + - Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see [method set_texcoord_mode]). - - + + + + + + + + + + + + + + + + + + + + - Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - Diffuse Lighting (light scattered from surface). + - - Detail Layer for diffuse lighting. + - - Specular Lighting (light reflected from the surface). + - - Emission Lighting (light emitted from the surface). + - - Specular Exponent (size of the specular dot). + - - Glow (Visible emitted scattered light). + - - Normal Map (irregularity map). + - + - - Maximum amount of parameters. + - - Read texture coordinates from the UV array. + - - Read texture coordinates from the UV array and transform them by uv_xform. + - - Read texture coordinates from the UV2 array. + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13798,7 +15958,7 @@ - + @@ -13813,6 +15973,316 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13916,6 +16386,110 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -14013,8 +16587,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -14028,7 +16638,7 @@ - + @@ -14052,7 +16662,7 @@ - + @@ -14100,7 +16710,7 @@ - + @@ -14112,7 +16722,7 @@ - + @@ -14138,7 +16748,7 @@ - + @@ -14166,9 +16776,9 @@ - + - + @@ -14185,30 +16795,12 @@ Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials. - - - - - - - - - - - - - - - - - - @@ -14223,6 +16815,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -14230,30 +16846,12 @@ Return the material override for the whole geometry. - - - - - - - - - - - - - - - - - - @@ -14268,6 +16866,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -14276,22 +16898,44 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - - - - - + @@ -14303,7 +16947,7 @@ - + Contains global variables accessible from everywhere. @@ -14316,19 +16960,19 @@ Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String]. - Example: - [codeblock] - Globals.set("category/property_name", 0) + Example: + [codeblock] + Globals.set("category/property_name", 0) - var property_info = { - "name": "category/property_name", - "type": TYPE_INT, - "hint": PROPERTY_HINT_ENUM, - "hint_string": "one,two,three" - } + var property_info = { + "name": "category/property_name", + "type": TYPE_INT, + "hint": PROPERTY_HINT_ENUM, + "hint_string": "one,two,three" + } - Globals.add_property_info(property_info) - [/codeblock] + Globals.add_property_info(property_info) + [/codeblock] @@ -14381,15 +17025,6 @@ - - - - - - - If returns true, this value can be saved to the configuration file. This is useful for editors. - - @@ -14407,6 +17042,20 @@ Convert a path to a localized path (res:// path). + + + + + + + + + + + + + + @@ -14421,6 +17070,14 @@ + + + + + + + + @@ -14430,15 +17087,6 @@ Set the order of a configuration value (influences when saved to the config file). - - - - - - - If set to true, this value can be saved to the configuration file. This is useful for editors. - - @@ -14762,12 +17410,6 @@ Return the type of the output connection 'idx'. - - - - - - @@ -14843,6 +17485,12 @@ + + + + + + @@ -14867,12 +17515,6 @@ - - - - - - @@ -14892,6 +17534,12 @@ + + + + + + @@ -14929,6 +17577,14 @@ + + + + + + + + @@ -15029,6 +17685,10 @@ + + + + @@ -15045,7 +17705,7 @@ - + @@ -15116,10 +17776,6 @@ - - - - @@ -15129,7 +17785,7 @@ - + @@ -15188,6 +17844,12 @@ + + + + + + @@ -15206,30 +17868,12 @@ - - - - - - - - - - - - - - - - - - @@ -15292,12 +17936,6 @@ - - - - - - @@ -15341,6 +17979,12 @@ + + + + + + @@ -15504,7 +18148,7 @@ Cloces the current connection, allows for reusal of [HTTPClient]. - + @@ -15543,7 +18187,7 @@ - + Return the response headers. @@ -15608,7 +18252,7 @@ - + Reads one chunk from the response. @@ -15621,7 +18265,7 @@ - + @@ -15644,9 +18288,9 @@ - + - + Sends a raw request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". @@ -15657,7 +18301,7 @@ - + Stub function @@ -15901,7 +18545,7 @@ - + @@ -15941,15 +18585,23 @@ + + + + + + + + - + - + This signal is emitted upon request completion. @@ -16033,6 +18685,28 @@ + + + + + + + + + + + + + + + + + + + + + + @@ -16068,6 +18742,12 @@ IP contains some support functions for the IPv4 protocol. TCP/IP support is in different classes (see [StreamPeerTCP] and [TCP_Server]). IP provides hostname resolution support, both blocking and threaded. + + + + + + @@ -16104,7 +18784,7 @@ - + Resolve a given hostname, blocking. Resolved hostname is returned as an IPv4 or IPv6 depending on "ip_type". @@ -16115,7 +18795,7 @@ - + Create a queue item for resolving a given hostname to an IPv4 or IPv6 depending on "ip_type". The queue ID is returned, or RESOLVER_INVALID_ID on error. @@ -16135,6 +18815,14 @@ + + + + + + + + @@ -16181,30 +18869,6 @@ Copy a "src_rect" [Rect2] from "src" [Image] to this [Image] on coordinates "dest". - - - - - - - - - Transfer data from "src" to this [Image] using a "brush" as a mask/brush on coordinates "pos". - - - - - - - - - - - - - Return a new [Image] from this [Image] that is created by brushhing see [method brush_transfer]. - - @@ -16242,7 +18906,7 @@ - + Return the raw data of the [Image]. @@ -16262,19 +18926,6 @@ Return the height of the [Image]. - - - - - - - - - - - Return the color of the pixel in the [Image] on coordinates "x,y" on mipmap level "mipmap_level". - - @@ -16307,19 +18958,6 @@ Load an [Image]. - - - - - - - - - - - Put a pixel of "color" on coordinates "x,y" on mipmap level "mipmap_level". - - @@ -16344,59 +18982,93 @@ - + - + - + - + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -16406,6 +19078,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A [Texture] based on an [Image]. @@ -16620,7 +19346,7 @@ A Singleton that deals with inputs. - A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joysticks, and input actions. + A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. @@ -16653,11 +19379,17 @@ If the device has an accelerometer, this will return the movement. - + - Returns an [Array] containing the device IDs of all currently connected joysticks. + Returns an [Array] containing the device IDs of all currently connected joypads. + + + + + + @@ -16675,7 +19407,7 @@ - Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope]) + Returns the current value of the joypad axis at given index (see JOY_* constants in [@Global Scope]) @@ -16725,7 +19457,7 @@ - Returns the name of the joystick at the specified device index + Returns the name of the joypad at the specified device index @@ -16743,7 +19475,14 @@ - Returns the strength of the joystick vibration: x is the strength of the weak motor, and y is the strength of the strong motor. + Returns the strength of the joypad vibration: x is the strength of the weak motor, and y is the strength of the strong motor. + + + + + + + Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. @@ -16767,13 +19506,6 @@ Return the mouse mode. See the constants for more information. - - - - - Returns the mouse speed for the last time the cursor was moved, and this until the next frame where the mouse moves. This means that even if the mouse is not moving, this function will still return the value of the last motion. - - @@ -16807,7 +19539,7 @@ - Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) + Returns if the joypad button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) @@ -16816,7 +19548,7 @@ - Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. + Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. @@ -16837,6 +19569,12 @@ Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope]. + + + + + + @@ -16870,7 +19608,7 @@ - Starts to vibrate the joystick. Joysticks usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). + Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. weak_magnitude is the strength of the weak motor (between 0 and 1) and strong_magnitude is the strength of the strong motor (between 0 and 1). duration is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). Note that not every hardware is compatible with long effect durations, it is recommended to restart an effect if in need to play it for more than a few seconds. @@ -16878,7 +19616,7 @@ - Stops the vibration of the joystick. + Stops the vibration of the joypad. @@ -16896,7 +19634,7 @@ - Emitted when a joystick device has been connected or disconnected + Emitted when a joypad device has been connected or disconnected @@ -16910,6 +19648,8 @@ Captures the mouse. The mouse will be hidden and unable to leave the game window. But it will still register movement and mouse button presses. + + @@ -16984,13 +19724,13 @@ - + Event identifier, positive integer increased at each new event. - + Device identifier. - + Type of event (one of the [InputEvent] constants). @@ -17007,11 +19747,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -17084,13 +19824,13 @@ - + Event identifier, positive integer increased at each new event. - + Device identifier. - + Type of event (one of the [InputEvent] constants). @@ -17107,11 +19847,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -17124,12 +19864,12 @@ - + - Built-in input event type for joystick button events. + Built-in input event type for joypad button events. - Input event type for joystick button events that extends the global [InputEvent] type. + Input event type for joypad button events that extends the global [InputEvent] type. @@ -17184,22 +19924,22 @@ - + Event identifier, positive integer increased at each new event. - - Joystick button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. + + Joypad button identifier, one of the JOY_BUTTON_* constants in [@Global Scope]. - + Device identifier. - - Pressed state of the joystick button. + + Pressed state of the joypad button. - + Intensity of the button pressure, ranges from 0 to 1.0. - + Type of event (one of the [InputEvent] constants). @@ -17216,11 +19956,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -17233,12 +19973,12 @@ - + - Built-in input event type for joystick motion/axis events. + Built-in input event type for joypad motion/axis events. - Input event type for joystick motion/axis events that extends the global [InputEvent] type. + Input event type for joypad motion/axis events that extends the global [InputEvent] type. @@ -17292,19 +20032,19 @@ - + Event identifier, positive integer increased at each new event. - - Joystick axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. + + Joypad axis identifier, one of the JOY_AXIS_* constants in [@Global Scope]. - + Device identifier. - + Type of event (one of the [InputEvent] constants). - + Position of the axis, ranging from -1.0 to 1.0. A value of 0 means that the axis is in its neutral position. @@ -17321,11 +20061,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -17398,37 +20138,37 @@ - + Event identifier, positive integer increased at each new event. - + State of the Alt modifier. - + State of the Ctrl modifier. - + Device identifier. - + Echo state of the key, i.e. whether it's a repeat event or not. - + State of the Meta modifier. - + Pressed state of the key. - + Scancode of the key, one of the KEY_* constants in [@Global Scope]. - + State of the Shift modifier. - + Type of event (one of the [InputEvent] constants). - + Unicode identifier of the key (when relevant). @@ -17445,11 +20185,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -17522,55 +20262,55 @@ - + Event identifier, positive integer increased at each new event. - + State of the Alt modifier. - + Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope]. - + Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. - + State of the Control modifier. - + Device identifier. - + Whether the event is a double-click. - + Global position of the mouse click. - + Global X coordinate of the mouse click. - + Global Y coordinate of the mouse click. - + State of the Meta modifier. - + Local position of the mouse click. - + Pressed state of the mouse button. - + State of the Shift modifier. - + Type of event (one of the [InputEvent] constants). - + Local X coordinate of the mouse click. - + Local Y coordinate of the mouse click. @@ -17587,11 +20327,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -17664,64 +20404,64 @@ - + Event identifier, positive integer increased at each new event. - + State of the Alt modifier. - + Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope]. - + State of the Ctrl modifier. - + Device identifier. - + Global position of the mouse pointer. - + Global X coordinate of the mouse pointer. - + Global Y coordinate of the mouse pointer. - + State of the Meta modifier. - + Local position of the mouse pointer. - + Position of the mouse pointer relative to the previous mouse position. - + X coordinate of the mouse pointer relative to the previous mouse position. - + Y coordinate of the mouse pointer relative to the previous mouse position. - + State of the Shift modifier. - + Speed of the mouse pointer. - + Speed of the mouse pointer on the X axis. - + Speed of the mouse pointer on the Y axis. - + Type of event (one of the [InputEvent] constants). - + Local X coordinate of the mouse pointer. - + Local Y coordinate of the mouse pointer. @@ -17738,11 +20478,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -17815,43 +20555,43 @@ - + Event identifier, positive integer increased at each new event. - + Device identifier. - + Drag event index in the case of a multi-drag event. - + Position of the drag event. - + Position of the drag event relative to its start position. - + X coordinate of the drag event relative to its start position. - + Y coordinate of the drag event relative to its start position. - + Speed of the drag event. - + Speed of the drag event on the X axis. - + Speed of the drag event on the Y axis. - + Type of event (one of the [InputEvent] constants). - + X coordinate of the drag event. - + Y coordinate of the drag event. @@ -17868,11 +20608,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -17945,28 +20685,28 @@ - + Event identifier, positive integer increased at each new event. - + Device identifier. - + Touch event index in the case of a multi-touch event. - + Position of the touch event. - + Pressed state of the touch event. - + Type of event (one of the [InputEvent] constants). - + X coordinate of the touch event. - + Y coordinate of the touch event. @@ -17983,11 +20723,11 @@ Mouse button event. - - Joystick motion event. + + Joypad motion event. - - Joystick button event. + + Joypad button event. Screen touch event. @@ -18130,6 +20870,14 @@ Retrieve the path to the [PackedScene] resource file that is loaded by default when calling [method replace_by_instance]. + + + + + + + + @@ -18141,94 +20889,6 @@ - - - Integer Array. - - - Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. - - - - - - - - - Create from a generic array. - - - - - - - Append an element at the end of the array (alias of [method push_back]). - - - - - - - Append an [IntArray] at the end of this array. - - - - - - - - - - - Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - - - - - Reverse the order of the elements in the array (so first element will now be the last). - - - - - - - Append a value to the array. - - - - - - - Remove an element from the array by index. - - - - - - - Set the size of the [IntArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - - - - - - - - - Change the int at the given index. - - - - - - - Return the array size. - - - - - - @@ -18278,76 +20938,14 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + @@ -18512,7 +21110,7 @@ - + Returns the list of selected indexes. @@ -18869,6 +21467,16 @@ + + + + + + + + + + @@ -18933,6 +21541,16 @@ + + + + + + + + + + @@ -18984,7 +21602,7 @@ - + Return the body that collided with this one. @@ -19086,6 +21704,18 @@ + + + + + + + + + + + + @@ -19100,7 +21730,7 @@ - + Return the body that collided with this one. @@ -19233,7 +21863,7 @@ - + @@ -19242,6 +21872,10 @@ + + + + @@ -19421,6 +22055,26 @@ + + + + + + + + + + + + + + + + + + + + Align rows to the left (default). @@ -19540,6 +22194,10 @@ + + + + @@ -19551,41 +22209,33 @@ Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting. - - - - - - - - - + - + - + - - + + - + @@ -19597,22 +22247,20 @@ - + - - + + - - - - + + @@ -19623,65 +22271,87 @@ - + - - - - - - - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + @@ -19714,18 +22384,16 @@ Return the height of the Light2D. Used with 2D normalmapping. - + - Return the item mask of the Light2D. - + - Return the item shadow mask of the Light2D. @@ -19763,11 +22431,16 @@ Return the color of casted shadows for this Light2D. - + + + + + + + - Return the Exponential Shadow Multiplier (ESM) value of the Light2D. @@ -19805,6 +22478,12 @@ Get the minimum Z value that objects of the scene have to be in order to be affected by the Light2D. + + + + + + @@ -19826,6 +22505,12 @@ Set the color of the Light2D. + + + + + + @@ -19847,15 +22532,15 @@ Set the height of the Light2D. Used with 2D normalmapping. - - + + Set the item mask of the Light2D to 'item_mask' value. - - + + Set the item shadow mask to 'item_shadow_mask' value. @@ -19903,11 +22588,16 @@ Enable or disable shadows casting from this Light2D according to the 'enabled' parameter. - + + + + + + + - Set the Exponential Shadow Multiplier (ESM) value of the Light2D. @@ -19946,6 +22636,48 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light. @@ -19998,9 +22730,231 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Control that provides single line string editing. @@ -20193,6 +23147,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -20291,6 +23269,12 @@ + + + + + + @@ -20331,6 +23315,12 @@ + + + + + + The LinkButton will always show an underline at the bottom of its text @@ -20394,7 +23384,7 @@ - + @@ -20471,15 +23461,15 @@ - + - + - + - + - + @@ -20516,7 +23506,7 @@ - + @@ -20542,7 +23532,7 @@ - + @@ -20575,449 +23565,7 @@ Material is a base [Resource] used for coloring and shading geometry. All materials inherit from it and almost all [VisualInstance] derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. - - - - - Return blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations. - - - - - - - - - - - - - - - Return a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. - - - - - - - Return the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). - - - - - - - Set blend mode for the material, which can be one of BLEND_MODE_MIX (default), BLEND_MODE_ADD, BLEND_MODE_SUB. Keep in mind that only BLEND_MODE_MIX ensures that the material [i]may[/i] be opaque, any other blend mode will render with alpha blending enabled in raster-based [VisualServer] implementations. - - - - - - - - - - - - - - - Set a [Material] flag, which toggles on or off a behavior when rendering. See enumeration FLAG_* for a list. - - - - - - - Set the line width for geometry drawn with FLAG_WIREFRAME enabled, or LINE primitives. Note that not all hardware or VisualServer backends support this (like DirectX). - - - - - Geometry is visible when this flag is enabled (default). - - - Both front facing and back facing triangles are rendered when this flag is enabled. - - - Front facing and back facing order is swapped when this flag is enabled. - - - Shading (lighting) is disabled when this flag is enabled. - - - - - - - - - Maximum amount of flags. - - - - - - - - - - - Use the regular alpha blending equation (source and dest colors are faded) (default). - - - Use additive blending equation, often used for particle effects such as fire or light decals. - - - Use subtractive blending equation, often used for some smoke effects or types of glass. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 3x3 matrix datatype. - - - 3x3 matrix used for 3D rotation and scale. Contains 3 vector fields x,y and z as its columns, which can be interpreted as the local basis vectors of a transformation. Can also be accessed as array of 3D vectors. These vectors are orthogonal to each other, but are not necessarily normalized. Almost always used as orthogonal basis for a [Transform]. - For such use, it is composed of a scaling and a rotation matrix, in that order (M = R.S). - - - - - - - - - Create a rotation matrix from the given quaternion. - - - - - - - - - - - Create a rotation matrix which rotates around the given axis by the specified angle. The axis must be a normalized vector. - - - - - - - - - - - - - Create a matrix from 3 axis vectors. - - - - - - - Return the determinant of the matrix. - - - - - - - Return Euler angles (in the XYZ convention: first Z, then Y, and X last) from the matrix. Returned vector contains the rotation angles in the format (third,second,first). - This function only works if the matrix represents a proper rotation. - - - - - - - This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code. - - - - - - - Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. - - - - - - - Return the inverse of the matrix. - - - - - - - Return the orthonormalized version of the matrix (useful to call from time to time to avoid rounding error for orthogonal matrices). This performs a Gram-Schmidt orthonormalization on the basis of the matrix. - - - - - - - - - - - Introduce an additional rotation around the given axis by phi. Only relevant when the matrix is being used as a part of [Transform]. The axis must be a normalized vector. - - - - - - - - - Introduce an additional scaling specified by the given 3D scaling factor. Only relevant when the matrix is being used as a part of [Transform]. - - - - - - - - - Transposed dot product with the x axis of the matrix. - - - - - - - - - Transposed dot product with the y axis of the matrix. - - - - - - - - - Transposed dot product with the z axis of the matrix. - - - - - - - Return the transposed version of the matrix. - - - - - - - - - Return a vector transformed (multiplied) by the matrix and return it. - - - - - - - - - Return a vector transformed (multiplied) by the transposed matrix and return it. Note that this is a multiplication by inverse only when the matrix represents a rotation-reflection. - - - - - - - - - - - - - - - - - 3x2 Matrix for 2D transforms. - - - 3x2 Matrix for 2D transforms. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Return the inverse of the matrix. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -21037,6 +23585,10 @@ + + + + @@ -21078,54 +23630,48 @@ Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. - + - + - + - + Create a new surface ([method get_surface_count] that will become surf_idx for this. Surfaces are created to be rendered using a "primitive", which may be PRIMITIVE_POINTS, PRIMITIVE_LINES, PRIMITIVE_LINE_STRIP, PRIMITIVE_LINE_LOOP, PRIMITIVE_TRIANGLES, PRIMITIVE_TRIANGLE_STRIP, PRIMITIVE_TRIANGLE_FAN. (As a note, when using indices, it is recommended to only use just points, lines or triangles). - The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed. + (might be obsolete) The format of a surface determines which arrays it will allocate and hold, so "format" is a combination of ARRAY_FORMAT_* mask constants ORed together. ARRAY_FORMAT_VERTEX must be always present. "array_len" determines the amount of vertices in the array (not primitives!). if ARRAY_FORMAT_INDEX is in the format mask, then it means that an index array will be allocated and "index_array_len" must be passed - + - - - - - - - + - + - + @@ -21133,6 +23679,12 @@ + + + + + + @@ -21144,14 +23696,14 @@ - - + + - - + + @@ -21353,7 +23905,7 @@ - + @@ -21437,7 +23989,7 @@ - + @@ -21459,7 +24011,7 @@ - + @@ -21467,7 +24019,7 @@ - + @@ -21513,7 +24065,7 @@ - + @@ -21553,7 +24105,7 @@ - + @@ -21609,7 +24161,7 @@ - + @@ -21635,13 +24187,6 @@ This helper creates a [StaticBody] child [Node] using the mesh geometry as collision. It's mainly used for testing. - - - - - Return the AABB of the mesh, in local coordinates. - - @@ -21669,6 +24214,12 @@ + + + + + + @@ -21693,7 +24244,7 @@ - + Return the list of items. @@ -21793,19 +24344,20 @@ MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). - Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [method generate_aabb]. + Since instances may have any behavior, the Rect3 used for visibility must be provided by the user, or generated with [method generate_aabb]. - - - Generate a new visibility AABB, using mesh AABB and instance transforms. Since instance information is stored in the [VisualServer], this function is VERY SLOW and must NOT be used often. - - - + + + + Return the visibility Rect3. + + + + - Return the visibility AABB. @@ -21840,11 +24392,16 @@ Return the [Mesh] resource drawn as multiple instances. - - + + + + + + + + - Set the visibility AABB. If not provided, MultiMesh will not be visible. @@ -21879,8 +24436,38 @@ Set the [Mesh] resource to be drawn in multiple instances. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -21906,6 +24493,10 @@ + + + + @@ -21981,7 +24572,7 @@ - + @@ -22031,6 +24622,10 @@ + + + + @@ -22057,7 +24652,7 @@ - + @@ -22073,7 +24668,7 @@ - + @@ -22089,7 +24684,7 @@ - + @@ -22105,7 +24700,7 @@ - + @@ -22115,7 +24710,7 @@ - + @@ -22129,18 +24724,24 @@ - + - + + + + + + + @@ -22175,6 +24776,12 @@ + + + + + + @@ -22185,13 +24792,13 @@ - + - + @@ -22199,7 +24806,7 @@ - + @@ -22213,7 +24820,7 @@ - + @@ -22227,7 +24834,7 @@ - + @@ -22241,7 +24848,7 @@ - + @@ -22259,18 +24866,26 @@ - + - + + + + + + + + + @@ -22305,6 +24920,12 @@ + + + + + + @@ -22483,43 +25104,43 @@ - + - + - + - + - + - + - + @@ -22579,13 +25200,13 @@ - + - + @@ -22603,7 +25224,7 @@ - + @@ -22654,6 +25275,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Base class for all the [i]scene[/i] elements. @@ -22760,10 +25465,11 @@ - + - Duplicate the node, returning a new [Node]. If [code]use_instancing[/code] is true, the duplicated node will be a new instance of the original [PackedScene], if not it will be an independent node. The duplicated node has the same group assignments and signals as the original one. + Duplicate the node, returning a new [Node]. + You can fine-tune the behavior using the [code]flags[/code], which are based on the DUPLICATE_* constants. @@ -22984,6 +25690,12 @@ Return true if fixed processing is enabled (see [method set_fixed_process]). + + + + + + @@ -23027,6 +25739,12 @@ Return true if the node is processing input (see [method set_process_input]). + + + + + + @@ -23102,6 +25820,10 @@ Replace a node in a scene by a given one. Subscriptions that pass through this node will be lost. + + + + @@ -23212,6 +25934,12 @@ Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_delta_time]. + + + + + + @@ -23253,6 +25981,12 @@ Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). + + + + + + @@ -23273,20 +26007,28 @@ + + + + + + + + - - - - - - - - Emitted when the node is renamed. + + + + + + + + @@ -23320,6 +26062,12 @@ + + + + + + @@ -23342,6 +26090,12 @@ + + + + + + @@ -23349,7 +26103,7 @@ Base node for 2D system. - Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierarchies for animation and positioning. + Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Transform2D]). A tree of Node2Ds allows complex hierarchies for animation and positioning. @@ -23368,21 +26122,21 @@ Return the rotation angle in radians needed for the 2d node to point at 'point' position. - + Return the global position of the 2D node. - + Return the global rotation in radians of the 2D node. - + @@ -23396,7 +26150,7 @@ Return the global scale of the 2D node. - + @@ -23404,25 +26158,26 @@ - + - Return the transform [Matrix32] calculated relatively to the parent of this 2D node. + Return the transform [Transform2D] calculated relatively to the parent of this 2D node. - + - Return the rotation of the 2D node. + Return the rotation in radians of the 2D node. - + + Return the rotation in degrees of the 2D node. @@ -23492,25 +26247,25 @@ Apply the 'ratio' scale to the 2D node, according to its current scale value. - + - Set the global position of the 2D node to 'pos'. + Set the global position of the 2D node. - + - Set the global rotation in radians of the 2D node. + Set the global rotation in radians of the 2D node - + - Set the global rotation in degrees of the 2D node. + Set the global rotation in degrees of the 2D node @@ -23521,31 +26276,31 @@ - + - Set the global transform [Matrix32] of the 2D node. + Set the global transform [Transform2D] of the 2D node. - + Set the position of the 2D node. - + - Set the rotation of the 2D node. + Set the rotation in radians of the 2D node. - + - Set the rotation of the 2D node. + Set the rotation in degrees of the 2D node. @@ -23556,10 +26311,10 @@ - + - Set the local transform [Matrix32] of the 2D node. + Set the local transform [Transform2D] of the 2D node. @@ -23584,6 +26339,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -23730,7 +26511,7 @@ - + @@ -23764,7 +26545,7 @@ - + Return the commandline passed to the engine. @@ -23777,13 +26558,6 @@ Returns the current screen index (0 padded). - - - - - Returns the value of the commandline argument "-level". - - @@ -23826,20 +26600,6 @@ Return the total amount of dynamic memory used (only works in debug). - - - - - Returns the current engine version information in a Dictionary. - - "major" - Holds the major version number as a String - "minor" - Holds the minor version number as a String - "patch" - Holds the patch version number as a String - "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String - "revision" - Holds the revision (e.g. "custom-build") as a String - "string" - major + minor + patch + status + revision in a single String - - @@ -23856,34 +26616,10 @@ Return the path to the current engine executable. - + - Return the total amount of frames drawn. - - - - - - - Returns the frames per second of the running game. - - - - - - - - - Return the list of fullscreen modes. - - - - - - - Return the amount of fixed iterations per second (for fixed process and physics). @@ -23901,13 +26637,6 @@ Return the host OS locale. - - - - - Return the main loop object (see [MainLoop]). - - @@ -23922,6 +26651,24 @@ Return the name of the host OS. Possible values are: "Android", "BlackBerry 10", "Flash", "Haiku", "iOS", "HTML5", "OSX", "Server", "Windows", "UWP", "X11" + + + + + + + + + + + + + + + + + + @@ -24026,12 +26773,6 @@ - - - - - - @@ -24048,12 +26789,6 @@ Returns current time as a dictionary of keys: hour, minute, second - - - - - - @@ -24084,15 +26819,6 @@ You can pass the output from [method get_datetime_from_unix_time] directly into this function. Daylight savings time (dst), if present, is ignored. - - - - - - - Return the current video mode size. - - @@ -24175,24 +26901,6 @@ Return true if the engine was executed with -v (verbose stdout). - - - - - - - Return true if the current video mode is fullscreen. - - - - - - - - - Return true if the window is resizable. - - @@ -24279,7 +26987,7 @@ - + @@ -24314,17 +27022,16 @@ - - + + - - + + - Set the amount of fixed iterations per second (for fixed process and physics). @@ -24348,12 +27055,6 @@ Sets the current screen orientation, the argument value must be one of the SCREEN_ORIENTATION constants in this class. - - - - - - @@ -24362,13 +27063,6 @@ - - - - - Speeds up or slows down the physics by changing the delta variable. (delta * time_scale) - - @@ -24381,19 +27075,6 @@ - - - - - - - - - - - Change the video mode. - - @@ -24528,6 +27209,16 @@ + + + + + + + + + + @@ -24664,12 +27355,21 @@ + + Get a property from the object. + + + + + Return the class of the object as a string. + + @@ -24685,7 +27385,7 @@ - + Return the list of metadata in the object. @@ -24726,13 +27426,6 @@ Return the list of signals as an array of dictionaries. - - - - - Return the type of the object as a string. - - @@ -24765,6 +27458,15 @@ Return true if signal emission blocking is enabled. + + + + + + + Check the class of the object against a string (including inheritance). + + @@ -24784,15 +27486,6 @@ - - - - - - - Check the type of the object against a string (including inheritance). - - @@ -24892,7 +27585,7 @@ - + @@ -24916,12 +27609,20 @@ - + + + + + + + + + @@ -24939,7 +27640,41 @@ An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of an omnilight. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -25103,6 +27838,12 @@ + + + + + + @@ -25220,6 +27961,10 @@ + + + + @@ -25261,7 +28006,7 @@ - + @@ -25276,7 +28021,17 @@ + + + + + + + + + + @@ -25295,7 +28050,7 @@ - + Get a raw packet. @@ -25318,7 +28073,7 @@ - + Send a raw packet. @@ -25369,13 +28124,6 @@ Close the UDP socket the [PacketPeerUDP] is currently listening on. - - - - - Return the address of the remote peer(as a 32bit integer) that sent the last packet(that was received with [method get_packet] or [method get_var]). - - @@ -25402,7 +28150,7 @@ - + @@ -25413,7 +28161,7 @@ If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists). - + @@ -25562,6 +28310,20 @@ + + + + + + + + + + + + + + @@ -25614,6 +28376,14 @@ + + + + + + + + @@ -25696,283 +28466,29 @@ + + + + + + + + + + + + + + - - - Particle system 3D Node - - - Particles is a particle system 3D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). - - - - - - - Return the total amount of particles in the system. - - - - - - - - - Return the color of a color phase. - - - - - - - - - Return the position of a color phase (0 to 1). - - - - - - - - - - - - - - - - - - - Return the half extents for the emission box. - - - - - - - - - - - - - - - - - - - Return the normal vector towards where gravity is pulling (by default, negative Y). - - - - - - - Return the material used to draw particles. - - - - - - - - - Return the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. - - - - - - - - - Return a specific variable for the particle system (see VAR_* enum). - - - - - - - Return the current visibility AABB. - - - - - - - - - - - - - Return the "emitting" property state (see [method set_emitting]). - - - - - - - - - - - - - Set total amount of particles in the system. - - - - - - - - - Set the color of a color phase. - - - - - - - - - Set the position of a color phase (0 to 1). - - - - - - - - - - - - - - - - - - - Set the half extents for the emission box. - - - - - - - - - - - - - - - - - - - Set the "emitting" property state. When emitting, the particle system generates new particles at constant rate. - - - - - - - Set the normal vector towards where gravity is pulling (by default, negative Y). - - - - - - - - - - - - - Set the material used to draw particles. - - - - - - - - - Set the randomness for a specific variable of the particle system. Randomness produces small changes from the default each time a particle is emitted. - - - - - - - - - - - - - - - Set a specific variable for the particle system (see VAR_* enum). - - - - - - - Set the visibility AABB for the particle system, since the default one will not work properly most of the time. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 2D Particle emitter - Particles2D is a particle system 2D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility AABB (although helpers to create one automatically exist). + Particles2D is a particle system 2D [Node] that is used to simulate several types of particle effects, such as explosions, rain, snow, fireflies, or other magical-like shinny sparkles. Particles are drawn using impostors, and given their dynamic behavior, the user must provide a visibility bounding box (although helpers to create one automatically exist). @@ -26026,7 +28542,7 @@ - + @@ -26085,6 +28601,12 @@ + + + + + + @@ -26202,7 +28724,7 @@ - + @@ -26280,6 +28802,12 @@ + + + + + + @@ -26318,6 +28846,134 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Direction in degrees at which the particles will be launched, Notice that when the direction is set to 0 the particles will be launched to the negative @@ -26367,83 +29023,13 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -26470,6 +29056,10 @@ + + + + @@ -26496,6 +29086,10 @@ + + + + @@ -26739,59 +29333,6 @@ - - - Singleton containing the list of remapped resources. - - - When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necessary to access to this directly (path remapping happens automatically when opening a file), it's exported just for information. - - - - - - - - - - - Add a remap from a file to another. - - - - - Clear all remaps. - - - - - - - Erase a remap. - - - - - - - - - Return the remapped new path of a file. - - - - - - - - - Return true if a file is being remapped. - - - - - - @@ -27035,7 +29576,7 @@ - + Return the transform matrix of the body. @@ -27075,7 +29616,7 @@ - + Change the transform matrix of the body. @@ -27245,7 +29786,7 @@ - + Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -27313,7 +29854,7 @@ - + @@ -27342,7 +29883,7 @@ - + @@ -27420,7 +29961,7 @@ - + Set the transform matrix for an area shape. @@ -27447,7 +29988,7 @@ - + Set the transform matrix for an area. @@ -27478,7 +30019,7 @@ - + Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. @@ -27635,7 +30176,7 @@ - + @@ -27845,7 +30386,7 @@ - + Set the transform matrix for a body shape. @@ -27876,7 +30417,7 @@ - + @@ -28343,7 +30884,7 @@ - + Return the transform matrix of the shape queried. @@ -28399,7 +30940,7 @@ - + Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. @@ -28535,6 +31076,20 @@ + + + + + + + + + + + + + + @@ -28549,22 +31104,22 @@ - - - - - - - - - - + + - - + + + + + + + + + + @@ -28583,21 +31138,13 @@ - - - - - - - - - - - - - - + + + + + + @@ -28616,14 +31163,14 @@ Adds a body to the collision exception list. This list contains bodies that this body will not collide with. - + - Return the physics layers this area can scan for collisions. + Return the physics layer this area is in. - + @@ -28632,14 +31179,14 @@ Return an individual bit on the collision mask. - + - Return the physics layer this area is in. + Return the physics layers this area can scan for collisions. - + @@ -28669,6 +31216,24 @@ Removes a body from the collision exception list. + + + + + Set the physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + + + + + + + + + Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. + + @@ -28685,24 +31250,6 @@ Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. - - - - - Set the physics layers this area is in. - Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. - A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. - - - - - - - - - Set/clear individual bits on the layer mask. This makes getting a body in/out of only one layer easier. - - @@ -28718,6 +31265,18 @@ + + + + + + + + + + + + @@ -28743,7 +31302,7 @@ - + @@ -28756,7 +31315,7 @@ - + @@ -28839,7 +31398,7 @@ - + @@ -28857,8 +31416,8 @@ - - + + @@ -29259,6 +31818,14 @@ + + + + + + + + @@ -30326,6 +32893,14 @@ + + + + + + + + @@ -30356,6 +32931,10 @@ + + + + @@ -30500,15 +33079,15 @@ - + - + - + - + - + @@ -30533,6 +33112,10 @@ + + + + @@ -30573,7 +33156,7 @@ - + Return the set of vertices that defines this polygon. @@ -30608,14 +33191,14 @@ - + Return the texture coordinates associated with every vertex of the polygon. - + Return the list of vertex colors. @@ -30650,7 +33233,7 @@ - + Define the set of vertices that will represent the polygon. @@ -30685,14 +33268,14 @@ - + Set the texture coordinates for every vertex of the polygon. There should be one uv vertex for every vertex in the polygon. If there are less, the undefined ones will be assumed to be (0,0). Extra uv vertices are ignored. - + Set the color for each vertex of the polygon. There should be one color for every vertex in the polygon. If there are less, the undefined ones will be assumed to be [method get_color]. Extra color entries are ignored. @@ -30700,6 +33283,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -30710,7 +33317,7 @@ - + @@ -30734,7 +33341,7 @@ - + @@ -30768,14 +33375,666 @@ - + - + + + + + + + + + + + Raw byte array. + + + Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. + + + + + + + + + Create from a generic array. + + + + + + + + + + + + + Append an [PoolByteArray] at the end of this array. + + + + + + + Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). + + + + + + + Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. + + + + + + + + + + + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + + + + + Reverse the order of the elements in the array (so first element will now be the last). + + + + + + + Append an element at the end of the array. + + + + + + + Remove an element from the array by index. + + + + + + + Set the size of the [PoolByteArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + + + + + + + + + Change the byte at the given index. + + + + + + + Return the size of the array. + + + + + + + + + + + Returns the slice of the [PoolByteArray] between indices (inclusive) as a new [RawArray]. Any negative index is considered to be from the end of the array. + + + + + + + + + Array of Colors + + + Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. + + + + + + + + + Create from a generic array. + + + + + + + Append an element at the end of the array (alias of [method push_back]). + + + + + + + Append an [PoolColorArray] at the end of this array. + + + + + + + + + + + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + + + + + Reverse the order of the elements in the array (so first element will now be the last). + + + + + + + Append a value to the array. + + + + + + + Remove an element from the array by index. + + + + + + + Set the size of the [PoolColorArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + + + + + + + + + Change the [Color] at the given index. + + + + + + + Return the array size. + + + + + + + + + Integer Array. + + + Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. + + + + + + + + + Create from a generic array. + + + + + + + Append an element at the end of the array (alias of [method push_back]). + + + + + + + Append an [PoolIntArray] at the end of this array. + + + + + + + + + + + Insert a new int at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + + + + + Reverse the order of the elements in the array (so first element will now be the last). + + + + + + + Append a value to the array. + + + + + + + Remove an element from the array by index. + + + + + + + Set the size of the [PoolIntArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + + + + + + + + + Change the int at the given index. + + + + + + + Return the array size. + + + + + + + + + Real Array. + + + Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. + + + + + + + + + Create from a generic array. + + + + + + + Append an element at the end of the array (alias of [method push_back]). + + + + + + + Append an [RealArray] at the end of this array. + + + + + + + + + + + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + + + + + Reverse the order of the elements in the array (so first element will now be the last). + + + + + + + Append an element at the end of the array. + + + + + + + Remove an element from the array by index. + + + + + + + Set the size of the [RealArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + + + + + + + + + Change the float at the given index. + + + + + + + Return the size of the array. + + + + + + + + + String Array. + + + String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. + + + + + + + + + Create from a generic array. + + + + + + + Append an element at the end of the array (alias of [method push_back]). + + + + + + + Append an [StringArray] at the end of this array. + + + + + + + + + + + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + + + + + + + + + + + + + Reverse the order of the elements in the array (so first element will now be the last). + + + + + + + Append a string element at end of the array. + + + + + + + Remove an element from the array by index. + + + + + + + Set the size of the [StringArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + + + + + + + + + Change the [String] at the given index. + + + + + + + Return the size of the array. + + + + + + + + + An Array of Vector2. + + + An Array specifically designed to hold Vector2. + + + + + + + + + Construct a new [PoolVector2Array]. Optionally, you can pass in an Array that will be converted. + + + + + + + Append an element at the end of the array (alias of [method push_back]). + + + + + + + Append an [PoolVector2Array] at the end of this array. + + + + + + + + + + + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + + + + + Reverse the order of the elements in the array (so first element will now be the last). + + + + + + + Insert a [Vector2] at the end. + + + + + + + Remove an element from the array by index. + + + + + + + Set the size of the PoolVector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + + + + + + + + + Change the [Vector2] at the given index. + + + + + + + Return the size of the array. + + + + + + + + + An Array of Vector3. + + + An Array specifically designed to hold Vector3. + + + + + + + + + Construct a new PoolVector3Array. Optionally, you can pass in an Array that will be converted. + + + + + + + Append an element at the end of the array (alias of [method push_back]). + + + + + + + Append an [PoolVector3Array] at the end of this array. + + + + + + + + + + + Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + + + + + Reverse the order of the elements in the array (so first element will now be the last). + + + + + + + Insert a Vector3 at the end. + + + + + + + Remove an element from the array by index. + + + + + + + Set the size of the PoolVector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. + + + + + + + + + Change the [Vector3] at the given index. + + + + + + + Return the size of the array. + + + @@ -30795,6 +34054,8 @@ + + Popup (show the control in modal form). @@ -30828,6 +34089,10 @@ + + + + @@ -30885,6 +34150,8 @@ + + @@ -30908,6 +34175,8 @@ + + @@ -30931,6 +34200,8 @@ + + @@ -30955,6 +34226,8 @@ + + @@ -30974,13 +34247,6 @@ Clear the popup menu, in effect removing all items. - - - - - Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. - - @@ -31057,6 +34323,21 @@ Return the text of the item at index "idx". + + + + + + + + + + + + + Returns a boolean that indicates whether or not the PopupMenu will hide on item selection. + + @@ -31184,6 +34465,8 @@ + + @@ -31205,13 +34488,40 @@ Set the text of the item at index "idx". + + + + + + + + + + + + + + + + + + + + - + - This even is emitted when an item is pressed or its accelerator is activated. The id of the item is returned if it exists, else the index. + This event is emitted when an item of some id is pressed or its accelerator is activated. + + + + + + + This event is emitted when an item of some index is pressed or its accelerator is activated. @@ -31294,7 +34604,7 @@ - + Return the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. @@ -31336,7 +34646,7 @@ - + Set the portal shape. The shape is an array of [Vector2] points, representing a convex polygon in the X,Y plane. @@ -31391,6 +34701,10 @@ + + + + @@ -31447,6 +34761,10 @@ + + + + @@ -31515,6 +34833,16 @@ + + + + + + + + + + @@ -31548,13 +34876,13 @@ - Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. + Returns a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. - + Returns the rotation matrix corresponding to the given quaternion. @@ -31642,13 +34970,13 @@ - + - + - + - + @@ -31690,6 +35018,13 @@ Range is a base class for [Control] nodes that change a floating point [i]value[/i] between a [i]minimum[/i] and a [i]maximum[/i], using [i]step[/i] and [i]page[/i], for example a [ScrollBar]. + + + + + Return value mapped to 0 to 1 range. + + @@ -31718,39 +35053,32 @@ Return the stepping, if step is 0, stepping is disabled. - - - - - Return value mapped to 0 to 1 (unit) range. - - - - - - - Return the current value. - - - + - + - + + + + + Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. + + + @@ -31776,12 +35104,6 @@ Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. - - - - - - @@ -31789,15 +35111,8 @@ Set step value. If step is 0, stepping will be disabled. - - - - - Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max. - - - - + + @@ -31819,6 +35134,22 @@ + + + + + + + + + + + + + + + + @@ -31836,118 +35167,6 @@ - - - Raw byte array. - - - Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. - - - - - - - - - Create from a generic array. - - - - - - - - - - - - - Append an [RawArray] at the end of this array. - - - - - - - Returns a copy of the array's contents formatted as String. Fast alternative to get_string_from_utf8(), assuming the content is ASCII-only (unlike the UTF-8 function, this function maps every byte to a character in the string, so any multibyte sequence will be torn apart). - - - - - - - Returns a copy of the array's contents formatted as String, assuming the array is formatted as UTF-8. Slower than get_string_from_ascii(), but works for UTF-8. Usually you should prefer this function over get_string_from_ascii() to support international input. - - - - - - - - - - - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - - - - - Reverse the order of the elements in the array (so first element will now be the last). - - - - - - - Append an element at the end of the array. - - - - - - - Remove an element from the array by index. - - - - - - - Set the size of the [RawArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - - - - - - - - - Change the byte at the given index. - - - - - - - Return the size of the array. - - - - - - - - - - - Returns the slice of the [RawArray] between indices (inclusive) as a new [RawArray]. Any negative index is considered to be from the end of the array. - - - - - - Query the closest object intersecting a ray. @@ -32090,6 +35309,16 @@ + + + + + + + + + + @@ -32249,6 +35478,18 @@ + + + + + + + + + + + + @@ -32271,6 +35512,10 @@ + + + + @@ -32297,94 +35542,10 @@ - - - - - - Real Array . - - - Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. - - - - - - - - - Create from a generic array. - - - - - - - Append an element at the end of the array (alias of [method push_back]). - - - - - - - Append an [RealArray] at the end of this array. - - - - - - - - - - - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - - - - - Reverse the order of the elements in the array (so first element will now be the last). - - - - - - - Append an element at the end of the array. - - - - - - - Remove an element from the array by index. - - - - - - - Set the size of the [RealArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - - - - - - - - - Change the float at the given index. - - - - - - - Return the size of the array. - - - + + + + @@ -32501,13 +35662,211 @@ - + Ending corner. - + Position (starting corner). - + + Size from position to end. + + + + + + + + Axis-Aligned Bounding Box. + + + Rect3 provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size, and several utility functions. It is typically used for simple (fast) overlap tests. + + + + + + + + + + + Optional constructor, accepts position and size. + + + + + + + + + Return true if this [Rect3] completely encloses another one. + + + + + + + + + Return this [Rect3] expanded to include a given point. + + + + + + + Get the area of the [Rect3]. + + + + + + + + + Get the position of the 8 endpoints of the [Rect3] in space. + + + + + + + Return the normalized longest axis of the [Rect3]. + + + + + + + Return the index of the longest axis of the [Rect3] (according to [Vector3]::AXIS* enum). + + + + + + + Return the scalar length of the longest axis of the [Rect3]. + + + + + + + Return the normalized shortest axis of the [Rect3]. + + + + + + + Return the index of the shortest axis of the [Rect3] (according to [Vector3]::AXIS* enum). + + + + + + + Return the scalar length of the shortest axis of the [Rect3]. + + + + + + + + + Return the support point in a given direction. This is useful for collision detection algorithms. + + + + + + + + + Return a copy of the [Rect3] grown a given amount of units towards all the sides. + + + + + + + Return true if the [Rect3] is flat or empty. + + + + + + + Return true if the [Rect3] is empty. + + + + + + + + + Return true if the [Rect3] contains a point. + + + + + + + + + Return the intersection between two [Rect3]. An empty AABB (size 0,0,0) is returned on failure. + + + + + + + + + Return true if the [Rect3] overlaps with another. + + + + + + + + + Return true if the [Rect3] is at both sides of a plane. + + + + + + + + + + + Return true if the [Rect3] intersects the line segment between from and to + + + + + + + + + Combine this [Rect3] with another, a larger one is returned that contains both. + + + + + + Ending corner. + + + Position (starting corner). + + Size from position to end. @@ -32537,6 +35896,10 @@ + + + + @@ -32586,7 +35949,191 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Simple regular expression matcher. @@ -32690,6 +36237,10 @@ + + + + @@ -32786,6 +36337,10 @@ + + + + @@ -32808,16 +36363,10 @@ - - - - - - - - - - + + + + @@ -32829,6 +36378,10 @@ Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. + + + + @@ -32837,8 +36390,8 @@ - - + + @@ -32864,8 +36417,14 @@ Return the RID of the resource (or an empty RID). Many resources (such as [Texture], [Mesh], etc) are high level abstractions of resources stored in a server, so this function will return the original RID. - - + + + + + + + + @@ -32884,6 +36443,10 @@ Set the path of the resource. This is useful mainly for editors when saving/loading, and shouldn't be changed by anything else. Fails if another [Resource] already has path "path". + + + + @@ -32892,6 +36455,14 @@ + + + + + + + + @@ -32901,88 +36472,22 @@ - + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -33042,7 +36547,7 @@ - + @@ -33050,7 +36555,7 @@ - + @@ -33078,14 +36583,6 @@ - - - - - - - - @@ -33135,7 +36632,7 @@ - + Return the list of resources inside the preloader. @@ -33167,6 +36664,10 @@ + + + + @@ -33179,7 +36680,7 @@ - + @@ -33382,6 +36883,14 @@ + + + + + + + + @@ -33448,6 +36957,14 @@ + + + + + + + + @@ -33800,15 +37317,58 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. - + + + + + Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + + + @@ -33822,14 +37382,7 @@ This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. - - - - - Emitted when a body shape exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. - - - + @@ -34195,15 +37748,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + Emitted when a body enters into contact with this one. Contact monitor and contacts reported must be enabled for this to work. - + + + + + Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. + + + @@ -34217,14 +37811,7 @@ This signal not only receives the body that collided with this one, but also its [RID] (body_id), the shape index from the colliding body (body_shape), and the shape index from this body (local_shape) the other body collided with. - - - - - Emitted when a body exits contact with this one. Contact monitor and contacts reported must be enabled for this to work. - - - + @@ -34276,35 +37863,23 @@ Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a [VisualInstance] node to create rooms. See that class documentation for more information about rooms. - - - - - - - - - - - - - - - - + + + + @@ -34314,872 +37889,26 @@ - - - - - - - + - - - - - - - - - - - - - - - + + + + + - - - Audio sample (sound) class. - - - Sample provides an audio sample class, containing audio data, together with some information for playback, such as format, mix rate and loop. It is used by sound playback routines. - - - - - - - - - - - Create new data for the sample, with format (see FORMAT_* constants), stereo hint, and length in samples (not bytes). - Calling this method overrides previously existing data. Stereo samples are interleaved pairs of left and right points (in that order), but count as one sample for length purposes. - - - - - - - Return sample data as little endian. - - - - - - - Return the sample format. - - - - - - - Return the sample length in samples. Stereo samples count as one, even if they are made of a left and a right sample. - - - - - - - Return the loop begin position. - - - - - - - Return the loop end position. - - - - - - - Return the loop format. - - - - - - - Return the mix rate for the sample. - - - - - - - Return whether the current sample was created as stereo. - - - - - - - Set sample data. Data must be little endian, no matter the host platform, and exactly as long as to fit all samples. The length of this array can be calculated as follows: - Get the sample length ([method get_length]). If the sample format is FORMAT_PCM16, multiply it by 2. If the sample format is FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. If the sample is stereo ([method is_stereo]), multiply it by 2. - - - - - - - Set the loop begin position. It must be a valid frame and less than the loop end position. - - - - - - - Set the loop end position. It must be a valid frame and greater than the loop begin position. - - - - - - - Set the loop format (use LOOP_* constants as argument). - - - - - - - Set the mix rate for the sample (expected playback frequency). - - - - - - 8-bits signed PCM audio. - - - 16-bits signed little endian PCM audio. - - - IMA-ADPCM Audio. - - - No loop enabled. - - - Forward looping (when playback reaches loop end, goes back to loop begin). - - - Ping-pong looping (when playback reaches loop end, plays backward until loop begin). Not available in all platforms. - - - - - - Library that contains a collection of samples. - - - Library that contains a collection of [Sample], each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. - - - - - - - - - Add a sample to the library, with a given text ID. - - - - - - - - - Return the sample from the library matching the given text ID. Return null if the sample is not found. - - - - - - - - - - - - - - - Return true if the sample text ID exists in the library. - - - - - - - Remove the sample matching the given text ID. - - - - - - - - - Return the pitch scale for the given sample. - - - - - - - - - Return the volume (in dB) for the given sample. - - - - - - - - - Set the pitch scale for the given sample. - - - - - - - - - Set the volume (in dB) for the given sample. - - - - - - - - - Sample Player node. - - - SamplePlayer is a [Node] meant for simple sample playback. A library of samples is loaded and played back "as is", without positioning or anything. - - - - - - - - - Return the current chorus send level for a given voice. - - - - - - - Return the default chorus send level of the player. - - - - - - - Return the default filter cutoff frequency of the player. - - - - - - - Return the default filter gain of the player. - - - - - - - Return the default filter resonance of the player. - - - - - - - Return the default filter type in use (see FILTER_* constants) for the player. - - - - - - - Return the default panning of the player. - - - - - - - Return the default pan depth of the player. - - - - - - - Return the default pan height of the player. - - - - - - - Return the default pitch scale of the player. - - - - - - - Return the default reverberation send level of the player. - - - - - - - Return the default reverberation room type of the player (see REVERB_* enum). - - - - - - - Return the default volume (on a linear scale) of the player. - - - - - - - Return the default volume (in dB) of the player. - - - - - - - - - Return the current filter cutoff frequency for a given voice. - - - - - - - - - Return the current filter gain for a given voice. - - - - - - - - - Return the current filter resonance for a given voice. - - - - - - - - - Return the current filter type in use (see FILTER_* constants) for a given voice. - - - - - - - - - Return the current mix rate for a given voice. - - - - - - - - - Return the current panning for a given voice. - - - - - - - - - Return the current pan depth for a given voice. - - - - - - - - - Return the current pan height for a given voice. - - - - - - - - - Return the current pitch scale for a given voice. - - - - - - - Return the polyphony of the player. - - - - - - - - - Return the current reverberation send level for a given voice. - - - - - - - - - Return the current reverberation room type for a given voice (see REVERB_* enum). - - - - - - - Return the sample library used by the player. - - - - - - - - - Return the current volume (on a linear scale) for a given voice. - - - - - - - - - Return the current volume (in dB) for a given voice. - - - - - - - Return whether the player is currently active. - - - - - - - - - Return whether the given voice is currently active. - - - - - - - - - - - Play a sample referenced by its name. - Optionally, the playback can be made "unique" to force stopping all other samples currently played. The voices allocated for playback will then be returned. - - - - - - - - - Set the chorus send level of a voice (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. - - - - - - - Set the default chorus send level of the player (from 0 to 1.0). For setting chorus parameters, see [AudioServer]. - - - - - - - - - - - - - Set the default filter for the player, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). - Optionally, a gain can also be given (from 0 to 2.0). - - - - - - - - - - - Set the default panning of the player. Panning goes from -1.0 (left) to +1.0 (right). - Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0). - - - - - - - Set the default pitch scale of the player. A ratio of 1.0 is the normal scale. - - - - - - - - - Set the default reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of the player. - - - - - - - Set the default volume of the player using a linear scale. - The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). - A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output. - - - - - - - Set the default volume of the player in dB. - The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half. - - - - - - - - - - - - - - - Set the filter for a given voice, using the given type (see FILTER_* constants), cutoff frequency (from 20 to 16,384 Hz) and resonance (from 0 to 4.0). - Optionally, a gain can also be given (from 0 to 2.0). - - - - - - - - - Set the mix rate (in Hz) of a given voice. - - - - - - - - - - - - - Set the panning of a voice. Panning goes from -1.0 (left) to +1.0 (right). - Optionally, for hardware than support 3D sound, one can also set depth and height (also in range -1.0 to +1.0). - - - - - - - - - Set the pitch scale of a given voice. A ratio of 1.0 is the normal scale. - - - - - - - Set the polyphony of the player (maximum amount of simultaneous voices). - - - - - - - - - - - Set the reverberation type (see REVERB_* constants) and send level (from 0 to 1.0) of a voice. - - - - - - - Set the sample library for the player. - - - - - - - - - Set the volume of a given voice using a linear scale. - The "volume" argument should be a positive factor ranging from 0.0 (mute) up to 16.0 (i.e. 24 dB). - A factor of 1.0 means that the voice will be played at normal system volume. Factors above 1.0 might be limited by the platform's audio output. - - - - - - - - - Set the volume of a given voice in dB. - The "dB" argument can range from -80 to 24 dB, 0 dB being the maximum volume. Every 6 dB (resp. -6 dB), the volume is increased (resp. reduced) by half. - - - - - - - Stop a given voice. - - - - - Stop all playing voices. - - - - - - Filter is disabled for voice. - - - Low-pass filter is used for voice. - - - Band-pass filter is used for voice. - - - High-pass filter is used for voice. - - - Notch (band reject) filter is used for voice. - - - Peak (exclusive band) filter is used for voice. - - - Band-limit filter is used for voice, in this case resonance is the high-pass cutoff. A band-limit filter has a different frequency response than a notch filter, but otherwise both are band-rejecting filters. - - - Low-shelf filter is used for voice. - - - High-shelf filter is used for voice. - - - Small reverberation room (house room). - - - Medium reverberation room (street) - - - Large reverberation room (theatre) - - - Huge reverberation room (cathedral, warehouse). - - - Value returned if the voice ID is invalid. - - - - - - Sample player for positional 2D Sound. - - - Sample player for positional 2D Sound. Plays sound samples positionally, left and right depending on the distance/place on the screen. - - - - - - - Return the polyphony of the player. - - - - - - - Return the amplitude used for random pitch scale variations. - - - - - - - Return the sample library used by the player. - - - - - - - - - Return whether a voice is still active or has stopped playing. - - - - - - - - - - - Play a sample. An internal polyphony ID can optionally be passed, or defaults to NEXT_VOICE. - Return a voice ID which can be used to modify the voice parameters, or INVALID_VOICE if the voice or sample are invalid. - - - - - - - Set the polyphony of the player (maximum amount of simultaneous voices). - - - - - - - Set the amplitude for random pitch scale variations. If different from zero, the pitch scale will vary randomly around 1.0 in a range defined by val. - The actual pitch scale will be, with "variation" ranging from -val to val: - * variation > 0: 1.0 + variation - * variation < 0: 1.0/(1.0 - variation) - - - - - - - Set the sample library for the player. - - - - - Stop all playing voices. - - - - - - - Stop a given voice. - - - - - - - - - Change the pitch scale of a currently playing voice. - - - - - - - - - Change the volume scale (in dB) of a currently playing voice. - - - - - - Value returned if the voice or sample are invalid. - - - Default voice for the play method. Corresponds to the first voice following the last used voice. - - - @@ -35247,7 +37976,7 @@ - + @@ -35340,6 +38069,12 @@ + + + + + + @@ -35349,6 +38084,14 @@ + + + + + + + + @@ -35379,6 +38122,8 @@ + + @@ -35434,6 +38179,13 @@ + + + + + Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]). + + @@ -35459,13 +38211,6 @@ Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections). - - - - - Returns true if there is a [NetworkedMultiplayerPeer] set (with [method SceneTree.set_network_peer]). - - @@ -35479,6 +38224,14 @@ + + + + + + + + @@ -35541,6 +38294,16 @@ + + + + + + + + + + @@ -35596,7 +38359,7 @@ - + @@ -35779,6 +38542,10 @@ + + + + @@ -35847,6 +38614,12 @@ + + + + + + @@ -35887,6 +38660,12 @@ + + + + + + @@ -35936,6 +38715,12 @@ To be changed, ignore. + + + + + + @@ -35944,30 +38729,12 @@ - - - - - - - - - - - - - - - - - - @@ -35977,15 +38744,7 @@ - - - - - - - - - + @@ -35999,923 +38758,19 @@ + + + + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -36937,11 +38792,11 @@ - + - + Return whether this shape is colliding with another. @@ -36951,11 +38806,11 @@ - + - + Return a list of the points where this shape touches another. If there are no collisions, the list is empty. @@ -36965,13 +38820,13 @@ - + - + @@ -36983,13 +38838,13 @@ - + - + @@ -37014,6 +38869,10 @@ + + + + @@ -37056,6 +38915,10 @@ + + + + @@ -37253,6 +39116,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Base class for GUI Sliders. @@ -37290,6 +39189,14 @@ + + + + + + + + @@ -37316,6 +39223,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -37365,96 +39318,6 @@ - - - Base class for playing spatial 2D sound. - - - Base class for playing spatial 2D sound. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base class for all 3D nodes. @@ -37538,12 +39401,6 @@ - - - - - - @@ -37556,12 +39413,24 @@ + + + + + + + + + + + + @@ -37629,12 +39498,6 @@ Set the transform globally, relative to worldspace. - - - - - - @@ -37651,6 +39514,12 @@ + + + + + + @@ -37682,6 +39551,12 @@ + + + + + + @@ -37697,6 +39572,24 @@ + + + + + + + + + + + + + + + + + + @@ -37725,320 +39618,12 @@ - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Server for Spatial 2D Sound. - - - Server for Spatial 2D Sound. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -38062,6 +39647,10 @@ + + + + @@ -38121,6 +39710,14 @@ + + + + + + + + @@ -38179,6 +39776,14 @@ + + + + + + + + @@ -38209,6 +39814,16 @@ + + + + + + + + + + @@ -38234,13 +39849,6 @@ Return the amount of horizontal frames. See [method set_hframes]. - - - - - Return color modulation for the sprite. All sprite pixels are multiplied by this color. - - @@ -38332,13 +39940,6 @@ Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. - - - - - Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. - - @@ -38375,6 +39976,28 @@ + + + + + + + + + + + + + + + + + + + + + + @@ -38467,6 +40090,20 @@ + + + + + + + + + + + + + + @@ -38613,6 +40250,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -38753,6 +40414,12 @@ + + + + + + @@ -38823,6 +40490,16 @@ + + + + + + + + + + @@ -38893,6 +40570,16 @@ + + + + + + + + + + @@ -39062,7 +40749,7 @@ - + Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. @@ -39085,7 +40772,7 @@ - + Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. @@ -39161,7 +40848,7 @@ - + @@ -39191,7 +40878,7 @@ - + @@ -39208,7 +40895,7 @@ SSL Stream peer. This object can be used to connect to SSL servers. - + @@ -39216,7 +40903,7 @@ - + @@ -39229,7 +40916,7 @@ Connect to a peer using an underlying [StreamPeer] "stream", when "validate_certs" is true, [StreamPeerSSL] will validate that the certificate presented by the peer matches the "for_hostname". - + Disconnect from host. @@ -39265,7 +40952,7 @@ TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a tcp server. - + @@ -39276,7 +40963,7 @@ Connect to the specified host:port pair. A hostname will be resolved if valid. Returns [OK] on success or [FAILED] on failure. - + Disconnect from host. @@ -39302,11 +40989,10 @@ Return the status of the connection, one of STATUS_* enum. - + - Return whether this peer is connected. Returns true while connecting and connected. @@ -39325,189 +41011,31 @@ - + - Base class for audio stream playback. - Base class for audio stream playback. Audio stream players inherit from it. - - - - - Return the size of the audio buffer. - - - - - - - Return the length of the stream, in seconds. - - - - - - - Return the number of times the playback has looped. - - - - - - - Return the point in time the stream will rewind to, when looping. - - - - - - - Return the playback position, in seconds. - - - - - - - Return the currently assigned stream. - - - + - Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>". - - + + - - Return the playback volume for this player. - - - - - - - Return the playback volume for this player, in decibels. - - - - - - - Return whether this player will start playing as soon as it enters the scene tree. - - - - - - - Return whether the stream will be restarted at the end. - - - - - - - Return whether the playback is currently paused. - - - - - - - Return whether this player is playing. - - - - + - Play the currently assigned stream, starting from a given position (in seconds). - - - - - - - Set the playback position, in seconds. - - - - - - - Set whether this player will start playing as soon as it enters the scene tree. - - - - - - - Set the size (in milliseconds) of the audio buffer. A long audio buffer protects better against slowdowns, but responds worse to changes (in volume, stream played...). A shorter buffer takes less time to respond to changes, but may stutter if the application suffers some slowdown. - Default is 500 milliseconds. - - - - - - - Set whether the stream will be restarted at the end. - - - - - - - Set the point in time the stream will rewind to, when looping. - - - - - - - Pause stream playback. - - - - - - - Set the [EventStream] this player will play. - - - - - - - Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 will amplify sound even more, but may introduce distortion. Negative values will just invert the output waveform, which produces no audible difference. - - - - - - - Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [method set_volume]) still apply. - - - - - Stop the playback. - - - - This signal triggers when the player stops playing. It will not trigger on each loop. - - - + + + + @@ -39519,11 +41047,204 @@ This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - If the string is a path to a file, return the path to the file without the extension. @@ -39536,7 +41257,7 @@ - + Return the bigrams (pairs of consecutive letters) of this string. @@ -39597,13 +41318,6 @@ Erase [code]chars[/code] characters from the string starting from [code]pos[/code]. - - - - - If the string is a path to a file, return the extension. - - @@ -39635,6 +41349,16 @@ Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + + + + + + + + + + @@ -39642,6 +41366,20 @@ If the string is a path to a file, return the base directory. + + + + + If the string is a path to a file, return the path to the file without the extension. + + + + + + + If the string is a path to a file, return the extension. + + @@ -39783,7 +41521,7 @@ - + Return the MD5 hash of the string as an array of bytes. @@ -39909,7 +41647,7 @@ - + @@ -39931,7 +41669,7 @@ - + @@ -39942,7 +41680,7 @@ - + @@ -39975,10 +41713,10 @@ - + - Convert the String (which is a character array) to RawArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. + Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. @@ -40010,10 +41748,10 @@ - + - Convert the String (which is an array of characters) to RawArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). + Convert the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). @@ -40034,94 +41772,6 @@ - - - String Array. - - - String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. - - - - - - - - - Create from a generic array. - - - - - - - Append an element at the end of the array (alias of [method push_back]). - - - - - - - Append an [StringArray] at the end of this array. - - - - - - - - - - - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - - - - - Reverse the order of the elements in the array (so first element will now be the last). - - - - - - - Append a string element at end of the array. - - - - - - - Remove an element from the array by index. - - - - - - - Set the size of the [StringArray]. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - - - - - - - - - Change the [String] at the given index. - - - - - - - Return the size of the array. - - - - - - Base class for drawing stylized boxes for the UI. @@ -40197,6 +41847,16 @@ + + + + + + + + + + @@ -40293,64 +41953,20 @@ - - - - - - Image mask based StyleBox, for mask test. - - - This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the point clicked is masked or not. - - - - - - - Return whether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. - - - - - - - - - Return the expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. - - - - - - - Return the image used for mask testing. (see [method set_image]). - - - - - - - Set the expand property (default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. - - - - - - - - - Set an expand margin size (from enum MARGIN_*). Parts of the image below the size of the margin (and in the direction of the margin) will not expand. - - - - - - - Set the image used for mask testing. Pixels (converted to grey) that have a value, less than 0.5 will fail the test. - - - + + + + + + + + + + + + + + @@ -40443,6 +42059,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -40461,7 +42103,7 @@ - + @@ -40497,15 +42139,15 @@ - + - + - + - + - + @@ -40531,7 +42173,7 @@ - + @@ -40596,7 +42238,7 @@ - + Listen on the "port" binding to "bind_address". @@ -40644,13 +42286,6 @@ Return the current tab index that is being shown. - - - - - Return the previous tab index that was being shown. - - @@ -40663,6 +42298,13 @@ + + + + + Return the previous tab index that was being shown. + + @@ -40686,6 +42328,14 @@ Return the amount of tabs. + + + + + + + + @@ -40723,6 +42373,14 @@ Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center. + + + + + + + + @@ -40749,6 +42407,14 @@ + + + + + + + + @@ -40761,7 +42427,7 @@ Emitted only when the current tab changes. - + @@ -40780,6 +42446,8 @@ + + @@ -40802,6 +42470,8 @@ + + @@ -40848,6 +42518,14 @@ + + + + + + + + @@ -40882,6 +42560,14 @@ + + + + + + + + @@ -40899,6 +42585,10 @@ + + + + @@ -40948,6 +42638,8 @@ + + @@ -40964,6 +42656,8 @@ + + @@ -41226,7 +42920,7 @@ - + @@ -41258,13 +42952,6 @@ Select all the text. - - - - - Set a custom background color. A background color with alpha==0 disables this. - - @@ -41293,13 +42980,6 @@ Set to enable showing line numbers. - - - - - Set the color for symbols. - - @@ -41327,6 +43007,20 @@ + + + + + + + + + + + + + + @@ -41386,6 +43080,8 @@ + + @@ -41508,13 +43204,6 @@ Return the texture height. - - - - - Return the texture RID as used in the [VisualServer]. - - @@ -41588,6 +43277,12 @@ + + + + + + @@ -41600,12 +43295,6 @@ - - - - - - @@ -41618,8 +43307,8 @@ - - + + @@ -41636,6 +43325,12 @@ + + + + + + @@ -41648,12 +43343,6 @@ - - - - - - @@ -41666,87 +43355,45 @@ - - - - - - - - - - - - - Control Frame that draws a texture. - - - Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + @@ -41843,6 +43490,22 @@ + + + + + + + + + + + + + + + + @@ -41858,6 +43521,78 @@ + + + Control Frame that draws a texture. + + + Control frame that simply draws an assigned texture. It can stretch or not. It's a simple way to just show an image in a UI. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Theme for controls. @@ -41922,7 +43657,7 @@ - + @@ -41940,7 +43675,7 @@ - + @@ -41964,7 +43699,7 @@ - + @@ -41982,7 +43717,7 @@ - + @@ -42000,7 +43735,7 @@ - + @@ -42008,13 +43743,13 @@ - + - + @@ -42128,6 +43863,10 @@ + + + + @@ -42277,7 +44016,7 @@ - + Return the custom transform matrix. @@ -42331,6 +44070,12 @@ Return an array of all cells containing a tile from the tileset (i.e. a tile index different from -1). + + + + + + @@ -42478,7 +44223,7 @@ - + Set custom transform matrix, to use in combination with the custom orientation mode. @@ -42545,6 +44290,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -42891,13 +44668,6 @@ Return true if set to automatically start when entering the scene. - - - - - Return if the timer is active or not. - - @@ -42905,11 +44675,17 @@ Return true if configured as one-shot. - - - + + + + + Return if the timer is paused or not. + + + + + - Set whether the timer is active or not. An inactive timer will be paused until it is activated again. @@ -42926,6 +44702,13 @@ Set as one-shot. If enabled, the timer will stop after timeout, otherwise it will automatically restart. + + + + + Set whether the timer is paused or not. A paused timer will be inactive until it is unpaused again. + + @@ -42951,6 +44734,16 @@ + + + + + + + + + + @@ -43019,6 +44812,12 @@ + + + + + + @@ -43049,6 +44848,12 @@ + + + + + + @@ -43067,6 +44872,18 @@ + + + + + + + + + + + + @@ -43086,6 +44903,24 @@ + + + + + + + + + + + + + + + + + + @@ -43104,7 +44939,7 @@ 3D Transformation. - Transform is used to store translation, rotation and scaling transformations. It consists of a Matrix3 "basis" and Vector3 "origin". Transform is used to represent transformations of objects in space, and as such, determine their position, orientation and scale. It is similar to a 3x4 matrix. + Transform is used to store translation, rotation and scaling transformations. It consists of a Basis "basis" and Vector3 "origin". Transform is used to represent transformations of objects in space, and as such, determine their position, orientation and scale. It is similar to a 3x4 matrix. @@ -43125,21 +44960,21 @@ - + - Construct the Transform from a Matrix3 and Vector3. + Construct the Transform from a Basis and Vector3. - + - Construct the Transform from a Matrix32. + Construct the Transform from a Transform2D. @@ -43154,10 +44989,10 @@ - + - Construct the Transform from a Matrix3. The origin will be Vector3(0, 0, 0). + Construct the Transform from a Basis. The origin will be Vector3(0, 0, 0). @@ -43241,16 +45076,169 @@ - + The basis is a matrix containing 3 [Vector3] as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system travelling with the object. - + The origin of the transform. Which is the translation offset. + + + 3x2 Matrix for 2D transforms. + + + 3x2 Matrix for 2D transforms. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Return the inverse of the matrix. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Language Translation. @@ -43298,7 +45286,7 @@ - + Return all the messages (keys). @@ -43312,6 +45300,12 @@ + + + + + + @@ -43547,12 +45541,6 @@ Get whether the editing of a cell should only happen when it is already selected. - - - - - - @@ -43608,12 +45596,6 @@ Set the amount of columns. - - - - - - @@ -43780,6 +45762,10 @@ + + + + @@ -44214,6 +46200,16 @@ + + + + + + + + + + Node useful for animations with unknown start and end points. @@ -44289,7 +46285,7 @@ Returns the time needed for all tweens to end in seconds, measured from the start. Thus, if you have two tweens, one ending 10 seconds after the start and the other - 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. - + @@ -44488,7 +46484,7 @@ Make the tween repeat after all tweens have finished. - + @@ -44587,8 +46583,12 @@ + + + + - + @@ -44597,7 +46597,7 @@ This signal is emitted when a tween ends. - + @@ -44985,6 +46985,13 @@ do_property]. Returns the angle in radians between the line connecting the two points and the x coordinate. + + + + + Returns the ratio of X to Y. + + @@ -45042,13 +47049,6 @@ do_property]. Remove the fractional part of x and y. - - - - - Returns the ratio of X to Y. - - @@ -45126,110 +47126,22 @@ do_property]. - + Height of the vector (Same as Y). - + Width of the vector (Same as X). - + X component of the vector. - + Y component of the vector. - - - An Array of Vector2. - - - An Array specifically designed to hold Vector2. - - - - - - - - - Construct a new [Vector2Array]. Optionally, you can pass in an Array that will be converted. - - - - - - - Append an element at the end of the array (alias of [method push_back]). - - - - - - - Append an [Vector2Array] at the end of this array. - - - - - - - - - - - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - - - - - Reverse the order of the elements in the array (so first element will now be the last). - - - - - - - Insert a [Vector2] at the end. - - - - - - - Remove an element from the array by index. - - - - - - - Set the size of the Vector2Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - - - - - - - - - Change the [Vector2] at the given index. - - - - - - - Return the size of the array. - - - - - - Vector class, which performs basic 3D vector math operations. @@ -45258,6 +47170,14 @@ do_property]. Returns a new vector with all components in absolute values (e.g. positive). + + + + + + + + @@ -45377,7 +47297,7 @@ do_property]. - + @@ -45424,7 +47344,7 @@ do_property]. - + Return a diagonal matrix with the vector as main diagonal. @@ -45432,13 +47352,13 @@ do_property]. - + X component of the vector. - + Y component of the vector. - + Z component of the vector. @@ -45454,94 +47374,6 @@ do_property]. - - - An Array of Vector3. - - - An Array specifically designed to hold Vector3. - - - - - - - - - Construct a new Vector3Array. Optionally, you can pass in an Array that will be converted. - - - - - - - Append an element at the end of the array (alias of [method push_back]). - - - - - - - Append an [Vector3Array] at the end of this array. - - - - - - - - - - - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). - - - - - Reverse the order of the elements in the array (so first element will now be the last). - - - - - - - Insert a Vector3 at the end. - - - - - - - Remove an element from the array by index. - - - - - - - Set the size of the Vector3Array. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. - - - - - - - - - Change the [Vector3] at the given index. - - - - - - - Return the size of the array. - - - - - - @@ -45620,6 +47452,18 @@ do_property]. + + + + + + + + + + + + @@ -45750,6 +47594,28 @@ do_property]. + + + + + + + + + + + + + + + + + + + + + + @@ -45912,6 +47778,20 @@ do_property]. + + + + + + + + + + + + + + @@ -45925,16 +47805,6 @@ do_property]. - - - - - - - - - - Creates a sub-view into the screen. @@ -45948,6 +47818,11 @@ do_property]. Finally, viewports can also behave as render targets, in which case they will not be visible unless the associated texture is used to draw. + + + Clear the viewport manually. + + @@ -45970,26 +47845,40 @@ do_property]. - + Get the canvas transform of the viewport. + + + + + Return whether automatic clearing of the render target on each frame is enabled. + + - + Get the total transform of the viewport. - + Get the global canvas transform of the viewport. + + + + + Get whether the rendered texture has filters enabled. + + @@ -45997,6 +47886,12 @@ do_property]. Get the mouse position, relative to the viewport. + + + + + + @@ -46004,55 +47899,6 @@ do_property]. Get whether picking for all physics objects inside the viewport is enabled. - - - - - Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. - - - - - - - Return whether automatic clearing of the render target on each frame is enabled. - - - - - - - Get whether the rendered texture has filters enabled. - - - - - - - Get whether the rendered texture will have mipmaps generated. - - - - - - - Get the render target's texture, for use with various objects that you want to texture with the viewport. - - - - - - - Get when the render target would be updated, will be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. - - - - - - - Set whether the render target is flipped on the Y axis. - - @@ -46060,6 +47906,27 @@ do_property]. Return the captured screenshot after [method queue_screen_capture]. You might need to check more than one frame until the right image is returned. + + + + + + + + + + + + + + + + + + + Return the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. Otherwise, if the rect is empty, the viewport will use all the allowed space. + + @@ -46067,11 +47934,32 @@ do_property]. Get the size override set with [method set_size_override]. - + + + + + Get the viewport's texture, for use with various objects that you want to texture with the viewport. + + + + + + + Get when the viewport would be updated, will be one of the [code]UPDATE_*[/code] constants. + + + + + + + Set whether the render target is flipped on the Y axis. + + + - Get the viewport RID from the visual server. + Get the viewport RID from the [VisualServer]. @@ -46092,6 +47980,7 @@ do_property]. + Return the 2D world of the viewport. @@ -46121,6 +48010,12 @@ do_property]. + + + + + + @@ -46142,13 +48037,6 @@ do_property]. Return whether input to the viewport is disabled. - - - - - Return whether the viewport is set as a render target by [method set_as_render_target]. - - @@ -46175,11 +48063,6 @@ do_property]. Queue a multithreaded screenshot, you can retrive it at a later frame via [method get_screen_capture]. - - - Clear the render target manually. - - @@ -46194,20 +48077,31 @@ do_property]. Makes the viewport send sounds from 2D emitters to the speakers. - - + + - Set the viewport's render target mode. - + Set the canvas transform of the viewport, useful for changing the on-screen positions of all child [CanvasItem]s. This is relative to the global canvas transform of the viewport. + + + + + + + + + + + + @@ -46216,12 +48110,24 @@ do_property]. - + Set the global canvas transform of the viewport. The canvas transform is relative to this. + + + + + + + + + + + + @@ -46229,53 +48135,25 @@ do_property]. Enable/disable picking for all physics objects inside the viewport. - - + + + + - Set the viewport rect. If the viewport is child of a control, it will use the same rect as the parent. - - + + - Enable/disable automatic clearing of the render target on each frame. You might find it better to disable this if you are using the viewport for rarely updated textures. To clear manually, check [method render_target_clear] - - + + - Set whether the rendered texture should have filters enabled. Disable if you want the texture's pixels be visible. - - - - - - - Set whether the rendered texture should have mipmaps generated. Mipmaps allow the texture to have better antialiasing from far away. - - - - - - - Map a part of the screen to the render target directly. - - - - - - - Set when the render target should be updated, has to be one of the [code]RENDER_TARGET_UPDATE_*[/code] constants. - - - - - - - Set whether the render target should be flipped on the Y axis. + Set the size of the viewport. @@ -46286,7 +48164,7 @@ do_property]. - Set the size of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. + Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. @@ -46303,6 +48181,13 @@ do_property]. If this viewport is a child of another viewport, keep the previously drawn background visible. + + + + + Set when the render target would be updated, using the [code]UPDATE_*[/code] constants + + @@ -46310,6 +48195,13 @@ do_property]. Make the viewport use a world separate from the parent viewport's world. + + + + + Set whether the viewport is flipped on the Y axis. + + @@ -46342,6 +48234,46 @@ do_property]. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -46350,85 +48282,94 @@ do_property]. - + Do not update the render target. - - Update the render target once, then switch to [code]RENDER_TARGET_UPDATE_DISABLED[/code] + + Update the render target once, then switch to [code]UPDATE_DISABLED[/code] - + Update the render target only when it is visible. This is the default value. - - Update the render target always. + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - Displays a viewport as a sprite. - Used to display a [Viewport] node at some position in the world, without having to mess with [RenderTargetTexture]s. - - - - - Get color modulation for the texture. All texture pixels are multiplied by this color. - - - - - - - get the offset to the origin of the texture. - - - - - - - Return the path to the shown [Viewport] node. - - - + - Return whether the viewport's texture is centered on the origin. - - + + - Set whether the viewport's texture should be centered on the origin. - - - - - - - Set color modulation for the texture. All texture pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. - - - - - - - Set the offset to the origin of the texture. - - - - - - - Set the path to the shown [Viewport] node. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -46459,6 +48400,12 @@ do_property]. + + + + + + This enabler will freeze [RigidBody] nodes. @@ -46497,6 +48444,20 @@ do_property]. + + + + + + + + + + + + + + This enabler will freeze [RigidBody2D] nodes. @@ -46528,7 +48489,7 @@ do_property]. - + Return the visibility bounding box of the VisibilityNotifier. @@ -46542,34 +48503,38 @@ do_property]. - + Set the visibility bounding box of the VisibilityNotifier. + + + + - + Emitted when the VisibilityNotifier enters a [Camera]'s view. - - - Emitted when the VisibilityNotifier enters the screen. - - - + Emitted when the VisibilityNotifier exits a [Camera]'s view. - + + + Emitted when the VisibilityNotifier enters the screen. + + + Emitted when the VisibilityNotifier exits the screen. @@ -46608,29 +48573,33 @@ do_property]. + + + + - + Emitted when the VisibilityNotifier2D enters the screen. - - - - - Emitted when the VisibilityNotifier2D enters a [Viewport]. - - - + Emitted when the VisibilityNotifier2D exits the screen. - + - Emitted when the VisibilityNotifier2D exits a [Viewport]. + Emitted when the VisibilityNotifier2D enters a [Viewport]'s view. + + + + + + + Emitted when the VisibilityNotifier2D exits a [Viewport]'s view. @@ -46644,7 +48613,7 @@ do_property]. - + @@ -46656,7 +48625,7 @@ do_property]. - + @@ -46674,6 +48643,10 @@ do_property]. + + + + @@ -47068,6 +49041,10 @@ do_property]. + + + + @@ -47112,6 +49089,12 @@ do_property]. + + + + + + @@ -47134,6 +49117,10 @@ do_property]. + + + + @@ -47168,6 +49155,12 @@ do_property]. + + + + + + @@ -47214,6 +49207,14 @@ do_property]. + + + + + + + + @@ -47256,6 +49257,12 @@ do_property]. + + + + + + @@ -47290,6 +49297,12 @@ do_property]. + + + + + + @@ -47452,6 +49465,14 @@ do_property]. + + + + + + + + @@ -47474,6 +49495,10 @@ do_property]. + + + + @@ -47496,6 +49521,10 @@ do_property]. + + + + @@ -47646,6 +49675,30 @@ do_property]. + + + + + + + + + + + + + + + + + + + + + + + + @@ -47710,6 +49763,10 @@ do_property]. + + + + @@ -47764,6 +49821,12 @@ do_property]. + + + + + + @@ -47818,6 +49881,12 @@ do_property]. + + + + + + @@ -47852,6 +49921,12 @@ do_property]. + + + + + + @@ -47874,6 +49949,10 @@ do_property]. + + + + @@ -47906,6 +49985,10 @@ do_property]. + + + + @@ -47946,6 +50029,12 @@ do_property]. + + + + + + @@ -47968,6 +50057,10 @@ do_property]. + + + + @@ -48062,6 +50155,24 @@ do_property]. + + + + + + + + + + + + + + + + + + @@ -48162,6 +50273,24 @@ do_property]. + + + + + + + + + + + + + + + + + + @@ -48190,6 +50319,10 @@ do_property]. + + + + @@ -48224,6 +50357,12 @@ do_property]. + + + + + + @@ -48246,6 +50385,10 @@ do_property]. + + + + @@ -48288,6 +50431,10 @@ do_property]. + + + + @@ -48348,6 +50495,12 @@ do_property]. + + + + + + @@ -48370,6 +50523,10 @@ do_property]. + + + + @@ -48392,6 +50549,10 @@ do_property]. + + + + @@ -48436,6 +50597,12 @@ do_property]. + + + + + + @@ -48500,6 +50667,16 @@ do_property]. + + + + + + + + + + @@ -48518,1274 +50695,6 @@ do_property]. The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -49840,312 +50749,8 @@ do_property]. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -50182,6 +50787,12 @@ do_property]. Return the close [TextureButton]. + + + + + + @@ -50189,6 +50800,12 @@ do_property]. Return the title of the window. + + + + + + @@ -50197,6 +50814,12 @@ do_property]. + + + + + + @@ -50210,6 +50833,8 @@ do_property]. + + @@ -50246,12 +50871,6 @@ do_property]. - - - - - - @@ -50265,6 +50884,10 @@ do_property]. + + + + @@ -50327,6 +50950,10 @@ do_property]. + + + + @@ -50444,7 +51071,7 @@ do_property]. - + Open a XML raw buffer for parsing. This returns an error code. @@ -50519,6 +51146,10 @@ do_property]. + + + + diff --git a/doc/tools/doc_status.py b/doc/tools/doc_status.py index e05bcd63e7..78f39fc7ec 100755 --- a/doc/tools/doc_status.py +++ b/doc/tools/doc_status.py @@ -20,6 +20,7 @@ flags = { 'p': False, 'o': True, 'i': False, + 'a': True, } flag_descriptions = { 'c': 'Toggle colors when outputting.', @@ -31,6 +32,7 @@ flag_descriptions = { 'p': 'Toggle showing percentage as well as counts.', 'o': 'Toggle overall column.', 'i': 'Toggle collapse of class items columns.', + 'a': 'Toggle showing all items.', } long_flags = { 'colors': 'c', @@ -58,6 +60,8 @@ long_flags = { 'items': 'i', 'collapse': 'i', + + 'all': 'a', } table_columns = ['name', 'brief_description', 'description', 'methods', 'constants', 'members', 'signals'] table_column_names = ['Name', 'Brief Desc.', 'Desc.', 'Methods', 'Constants', 'Members', 'Signals'] @@ -354,12 +358,11 @@ for cn in input_class_list: validate_tag(c, 'class') status = ClassStatus.generate_for_class(c) - if flags['b'] and status.is_ok(): - continue - if flags['g'] and not status.is_ok(): + total_status = total_status + status + + if (flags['b'] and status.is_ok()) or (flags['g'] and not status.is_ok()) or (not flags['a']): continue - total_status = total_status + status out = status.make_output() row = [] for column in table_columns: @@ -378,11 +381,11 @@ for cn in input_class_list: # Print output table # ################################################################################ -if len(table) == 1: +if len(table) == 1 and flags['a']: print(color('part_big_problem', 'No classes suitable for printing!')) sys.exit(0) -if len(table) > 2: +if len(table) > 2 or not flags['a']: total_status.name = 'Total = {0}'.format(len(table) - 1) out = total_status.make_output() row = []