diff --git a/doc/classes/AABB.xml b/doc/classes/AABB.xml index fac0305139c..e0117ce0c9b 100644 --- a/doc/classes/AABB.xml +++ b/doc/classes/AABB.xml @@ -15,192 +15,154 @@ - - - - - - + + + Constructs an [AABB] from a position and size. - - + Returns an AABB with equivalent position and size, modified so that the most-negative corner is the origin and the size is positive. - - - - + + Returns [code]true[/code] if this [AABB] completely encloses another one. - - - - + + Returns this [AABB] expanded to include a given point. - - + Returns the volume of the [AABB]. - - - - + + Gets the position of the 8 endpoints of the [AABB] in space. - - + Returns the normalized longest axis of the [AABB]. - - + Returns the index of the longest axis of the [AABB] (according to [Vector3]'s [code]AXIS_*[/code] constants). - - + Returns the scalar length of the longest axis of the [AABB]. - - + Returns the normalized shortest axis of the [AABB]. - - + Returns the index of the shortest axis of the [AABB] (according to [Vector3]::AXIS* enum). - - + Returns the scalar length of the shortest axis of the [AABB]. - - - - + + Returns the support point in a given direction. This is useful for collision detection algorithms. - - - - + + Returns a copy of the [AABB] grown a given amount of units towards all the sides. - - + Returns [code]true[/code] if the [AABB] is flat or empty. - - + Returns [code]true[/code] if the [AABB] is empty. - - - - + + Returns [code]true[/code] if the [AABB] contains a point. - - - - + + Returns the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure. - - - - + + Returns [code]true[/code] if the [AABB] overlaps with another. - - - - + + Returns [code]true[/code] if the [AABB] is on both sides of a plane. - - - - - - + + + Returns [code]true[/code] if the [AABB] intersects the line segment between [code]from[/code] and [code]to[/code]. - - - - + + Returns [code]true[/code] if this [AABB] and [code]aabb[/code] are approximately equal, by calling [method @GDScript.is_equal_approx] on each component. - - - - + + Returns a larger [AABB] that contains both this [AABB] and [code]with[/code]. diff --git a/doc/classes/ARVRAnchor.xml b/doc/classes/ARVRAnchor.xml index 37003b3fff1..c7cf63551ed 100644 --- a/doc/classes/ARVRAnchor.xml +++ b/doc/classes/ARVRAnchor.xml @@ -12,36 +12,31 @@ - - + Returns the name given to this anchor. - - + Returns [code]true[/code] if the anchor is being tracked and [code]false[/code] if no anchor with this ID is currently known. - - + If provided by the [ARVRInterface], this returns a mesh object for the anchor. For an anchor, this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes. - - + Returns a plane aligned with our anchor; handy for intersection testing. - - + Returns the estimated size of the plane that was detected. Say when the anchor relates to a table in the real world, this is the estimated size of the surface of that table. @@ -54,8 +49,7 @@ - - + Emitted when the mesh associated with the anchor changes or when one becomes available. This is especially important for topology that is constantly being [code]mesh_updated[/code]. diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index 990d253e4e0..ae89b787b83 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -13,54 +13,45 @@ - - + If active, returns the name of the associated controller if provided by the AR/VR SDK used. - - + Returns the hand holding this controller, if known. See [enum ARVRPositionalTracker.TrackerHand]. - - + Returns [code]true[/code] if the bound controller is active. ARVR systems attempt to track active controllers. - - - - + + Returns the value of the given axis for things like triggers, touchpads, etc. that are embedded into the controller. - - + Returns the ID of the joystick object bound to this. Every controller tracked by the [ARVRServer] that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. - - + If provided by the [ARVRInterface], this returns a mesh associated with the controller. This can be used to visualize the controller. - - - - + + Returns [code]true[/code] if the button at index [code]button[/code] is pressed. See [enum JoystickList], in particular the [code]JOY_VR_*[/code] constants. @@ -80,22 +71,19 @@ - - + Emitted when a button on this controller is pressed. - - + Emitted when a button on this controller is released. - - + Emitted when the mesh associated with the controller changes or when one becomes available. Generally speaking this will be a static mesh after becoming available. diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index bd724f5fdd6..fcdcb957aed 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -12,43 +12,37 @@ - - + If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed ID in the [CameraServer] for this interface. - - + Returns a combination of [enum Capabilities] flags providing information about the capabilities of this interface. - - + Returns the name of this interface (OpenVR, OpenHMD, ARKit, etc). - - + Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform. - - + If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking. - - + Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output. After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence. @@ -58,15 +52,13 @@ - - + Returns [code]true[/code] if the current output of this interface is in stereo. - - + Turns the interface off. diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index 73defd36e5c..f0ffc43ac59 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -13,80 +13,68 @@ - - + Returns the hand holding this tracker, if known. See [enum TrackerHand] constants. - - + If this is a controller that is being tracked, the controller will also be represented by a joystick entry with this ID. - - + Returns the mesh related to a controller or anchor point if one is available. - - + Returns the controller or anchor point's name if available. - - + Returns the controller's orientation matrix. - - + Returns the world-space controller position. - - + Returns the internal tracker ID. This uniquely identifies the tracker per tracker type and matches the ID you need to specify for nodes such as the [ARVRController] and [ARVRAnchor] nodes. - - + Returns [code]true[/code] if this device tracks orientation. - - + Returns [code]true[/code] if this device tracks position. - - - - + + Returns the transform combining this device's orientation and position. - - + Returns the tracker's type. diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index f966f0f65f6..16ec1a5999e 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -11,12 +11,9 @@ - - - - - - + + + This is an important function to understand correctly. AR and VR platforms all handle positioning slightly differently. For platforms that do not offer spatial tracking, our origin point (0,0,0) is the location of our HMD, but you have little control over the direction the player is facing in the real world. @@ -27,84 +24,70 @@ - - - - + + Finds an interface by its name. For instance, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it. - - + Returns the primary interface's transformation. - - - - + + Returns the interface registered at a given index in our list of interfaces. - - + Returns the number of interfaces currently registered with the AR/VR server. If your project supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try to initialize each interface and use the first one that returns [code]true[/code]. - - + Returns a list of available interfaces the ID and name of each interface. - - + Returns the absolute timestamp (in μs) of the last [ARVRServer] commit of the AR/VR eyes to [VisualServer]. The value comes from an internal call to [method OS.get_ticks_usec]. - - + Returns the duration (in μs) of the last frame. This is computed as the difference between [method get_last_commit_usec] and [method get_last_process_usec] when committing. - - + Returns the absolute timestamp (in μs) of the last [ARVRServer] process callback. The value comes from an internal call to [method OS.get_ticks_usec]. - - + Returns the reference frame transform. Mostly used internally and exposed for GDNative build interfaces. - - - - + + Returns the positional tracker at the given ID. - - + Returns the number of trackers currently registered. @@ -120,37 +103,29 @@ - - + Emitted when a new interface has been added. - - + Emitted when an interface is removed. - - - - - - + + + Emitted when a new tracker has been added. If you don't use a fixed number of controllers or if you're using [ARVRAnchor]s for an AR solution, it is important to react to this signal to add the appropriate [ARVRController] or [ARVRAnchor] nodes related to this new tracker. - - - - - - + + + Emitted when a tracker is removed. You should remove any [ARVRController] or [ARVRAnchor] points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one). diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index c20ee3544e5..92fbb1b0214 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -24,38 +24,28 @@ - - - - - - + + + Called when computing the cost between two connected points. Note that this function is hidden in the default [code]AStar[/code] class. - - - - - - + + + Called when estimating the cost between a point and the path's ending point. Note that this function is hidden in the default [code]AStar[/code] class. - - - - - - - - + + + + Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. @@ -67,34 +57,25 @@ - - - - - - - - + + + + Returns whether the two given points are directly connected by a segment. If [code]bidirectional[/code] is [code]false[/code], returns whether movement from [code]id[/code] to [code]to_id[/code] is possible through this segment. - - + Clears all the points and segments. - - - - - - - - + + + + Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction. [codeblock] @@ -106,42 +87,32 @@ - - - - - - - - + + + + Deletes the segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is prevented, and a unidirectional segment possibly remains. - - + Returns the next available point ID with no point associated to it. - - - - - - + + + Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool. [b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result. - - - - + + Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblock] @@ -155,12 +126,9 @@ - - - - - - + + + Returns an array with the IDs of the points that form the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. [codeblock] @@ -181,17 +149,14 @@ - - + Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code]. - - - - + + Returns an array with the IDs of the points that form the connection with the given point. [codeblock] @@ -209,114 +174,88 @@ - - + Returns the number of points currently in the points pool. - - - - - - + + + Returns an array with the points that are in the path found by AStar between the given points. The array is ordered from the starting point to the ending point of the path. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PoolVector3Array] and will print an error message. - - - - + + Returns the position of the point associated with the given [code]id[/code]. - - - - + + Returns the weight scale of the point associated with the given [code]id[/code]. - - + Returns an array of all points. - - - - + + Returns whether a point associated with the given [code]id[/code] exists. - - - - + + Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. - - - - + + Removes the point associated with the given [code]id[/code] from the points pool. - - - - + + Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. - - - - - - + + + Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. - - - - - - + + + Sets the [code]position[/code] for the point with the given [code]id[/code]. - - - - - - + + + Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index 262568e7115..722fd70953d 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -10,38 +10,28 @@ - - - - - - + + + Called when computing the cost between two connected points. Note that this function is hidden in the default [code]AStar2D[/code] class. - - - - - - + + + Called when estimating the cost between a point and the path's ending point. Note that this function is hidden in the default [code]AStar2D[/code] class. - - - - - - - - + + + + Adds a new point at the given position with the given identifier. The [code]id[/code] must be 0 or larger, and the [code]weight_scale[/code] must be 1 or larger. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. Thus, all else being equal, the algorithm prefers points with lower [code]weight_scale[/code]s to form a path. @@ -53,32 +43,24 @@ - - - - - - + + + Returns whether there is a connection/segment between the given points. - - + Clears all the points and segments. - - - - - - - - + + + + Creates a segment between the given points. If [code]bidirectional[/code] is [code]false[/code], only movement from [code]id[/code] to [code]to_id[/code] is allowed, not the reverse direction. [codeblock] @@ -90,40 +72,31 @@ - - - - - - + + + Deletes the segment between the given points. - - + Returns the next available point ID with no point associated to it. - - - - - - + + + Returns the ID of the closest point to [code]to_position[/code], optionally taking disabled points into account. Returns [code]-1[/code] if there are no points in the points pool. [b]Note:[/b] If several points are the closest to [code]to_position[/code], the one with the smallest ID will be returned, ensuring a deterministic result. - - - - + + Returns the closest position to [code]to_position[/code] that resides inside a segment between two connected points. [codeblock] @@ -137,12 +110,9 @@ - - - - - - + + + Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. [codeblock] @@ -163,17 +133,14 @@ - - + Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code]. - - - - + + Returns an array with the IDs of the points that form the connection with the given point. [codeblock] @@ -191,114 +158,88 @@ - - + Returns the number of points currently in the points pool. - - - - - - + + + Returns an array with the points that are in the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. [b]Note:[/b] This method is not thread-safe. If called from a [Thread], it will return an empty [PoolVector2Array] and will print an error message. - - - - + + Returns the position of the point associated with the given [code]id[/code]. - - - - + + Returns the weight scale of the point associated with the given [code]id[/code]. - - + Returns an array of all points. - - - - + + Returns whether a point associated with the given [code]id[/code] exists. - - - - + + Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. - - - - + + Removes the point associated with the given [code]id[/code] from the points pool. - - - - + + Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. - - - - - - + + + Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. - - - - - - + + + Sets the [code]position[/code] for the point with the given [code]id[/code]. - - - - - - + + + Sets the [code]weight_scale[/code] for the point with the given [code]id[/code]. The [code]weight_scale[/code] is multiplied by the result of [method _compute_cost] when determining the overall cost of traveling across a segment from a neighboring point to this point. diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 0798db81f41..24fb2387689 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -10,47 +10,37 @@ - - - - - - - - + + + + Adds a button with label [code]text[/code] and a custom [code]action[/code] to the dialog and returns the created button. [code]action[/code] will be passed to the [signal custom_action] signal when pressed. If [code]true[/code], [code]right[/code] will place the button to the right of any sibling buttons. - - - - + + Adds a button with label [code]name[/code] and a cancel action to the dialog and returns the created button. - - + Returns the label used for built-in text. - - + Returns the OK [Button] instance. - - - - + + Registers a [LineEdit] in the dialog. When the enter key is pressed, the dialog will be accepted. @@ -76,8 +66,7 @@ - - + Emitted when a custom button is pressed. See [method add_button]. diff --git a/doc/classes/AnimatedSprite.xml b/doc/classes/AnimatedSprite.xml index 6385072939f..0e71823b982 100644 --- a/doc/classes/AnimatedSprite.xml +++ b/doc/classes/AnimatedSprite.xml @@ -13,26 +13,21 @@ - - + Returns [code]true[/code] if an animation is currently being played. - - - - - - + + + Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. If [code]backwards[/code] is [code]true[/code], the animation will be played in reverse. - - + Stops the current animation (does not reset the frame counter). diff --git a/doc/classes/AnimatedSprite3D.xml b/doc/classes/AnimatedSprite3D.xml index f85906a7ccd..b8f9b4d947b 100644 --- a/doc/classes/AnimatedSprite3D.xml +++ b/doc/classes/AnimatedSprite3D.xml @@ -11,24 +11,20 @@ - - + Returns [code]true[/code] if an animation is currently being played. - - - - + + Plays the animation named [code]anim[/code]. If no [code]anim[/code] is provided, the current animation is played. - - + Stops the current animation (does not reset the frame counter). diff --git a/doc/classes/AnimatedTexture.xml b/doc/classes/AnimatedTexture.xml index d714c3a2210..42c5a69d8ef 100644 --- a/doc/classes/AnimatedTexture.xml +++ b/doc/classes/AnimatedTexture.xml @@ -13,30 +13,23 @@ - - - - + + Returns the given frame's delay value. - - - - + + Returns the given frame's [Texture]. - - - - - - + + + Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by [member fps]. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be [code]1.0 / fps + delay[/code]. For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be: @@ -49,12 +42,9 @@ - - - - - - + + + Assigns a [Texture] to the given frame. Frame IDs start at 0, so the first frame has ID 0, and the last frame of the animation has ID [member frames] - 1. You can define any number of textures up to [constant MAX_FRAMES], but keep in mind that only frames from 0 to [member frames] - 1 will be part of the animation. diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index cd97fa23cae..2595e6be81e 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -21,673 +21,487 @@ - - - - - - + + + Adds a track to the Animation. - - - - - - + + + Returns the animation name at the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Animation Track. - - - - - - - - + + + + Inserts a key with value [code]animation[/code] at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of an Animation Track. - - - - - - - - + + + + Sets the key identified by [code]key_idx[/code] to value [code]animation[/code]. The [code]track_idx[/code] must be the index of an Animation Track. - - - - - - + + + Returns the end offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. End offset is the number of seconds cut off at the ending of the audio stream. - - - - - - + + + Returns the start offset of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. Start offset is the number of seconds cut off at the beginning of the audio stream. - - - - - - + + + Returns the audio stream of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of an Audio Track. - - - - - - - - - - - - + + + + + + Inserts an Audio Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of an Audio Track. [code]stream[/code] is the [AudioStream] resource to play. [code]start_offset[/code] is the number of seconds cut off at the beginning of the audio stream, while [code]end_offset[/code] is at the ending. - - - - - - - - + + + + Sets the end offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. - - - - - - - - + + + + Sets the start offset of the key identified by [code]key_idx[/code] to value [code]offset[/code]. The [code]track_idx[/code] must be the index of an Audio Track. - - - - - - - - + + + + Sets the stream of the key identified by [code]key_idx[/code] to value [code]stream[/code]. The [code]track_idx[/code] must be the index of an Audio Track. - - - - - - + + + Returns the in handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - - - - - + + + Returns the out handle of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - - - - - + + + Returns the value of the key identified by [code]key_idx[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - - - - - - - - - - - + + + + + + Inserts a Bezier Track key at the given [code]time[/code] in seconds. The [code]track_idx[/code] must be the index of a Bezier Track. [code]in_handle[/code] is the left-side weight of the added Bezier curve point, [code]out_handle[/code] is the right-side one, while [code]value[/code] is the actual value at this point. - - - - - - + + + Returns the interpolated value at the given [code]time[/code] (in seconds). The [code]track_idx[/code] must be the index of a Bezier Track. - - - - - - - - + + + + Sets the in handle of the key identified by [code]key_idx[/code] to value [code]in_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - - - - - - - + + + + Sets the out handle of the key identified by [code]key_idx[/code] to value [code]out_handle[/code]. The [code]track_idx[/code] must be the index of a Bezier Track. - - - - - - - - + + + + Sets the value of the key identified by [code]key_idx[/code] to the given value. The [code]track_idx[/code] must be the index of a Bezier Track. - - + Clear the animation (clear all tracks and reset all). - - - - - - + + + Adds a new track that is a copy of the given track from [code]to_animation[/code]. - - - - + + Returns the index of the specified track. If the track is not found, return -1. - - + Returns the amount of tracks in the animation. - - - - - - - - + + + + Returns all the key indices of a method track, given a position and delta time. - - - - - - + + + Returns the method name of a method track. - - - - - - + + + Returns the arguments values to be called on a method track for a given key in a given track. - - - - + + Removes a track by specifying the track index. - - - - - - - - + + + + Finds the key index by time in a given track. Optionally, only find it if the exact time is given. - - - - + + Returns [code]true[/code] if the track at [code]idx[/code] wraps the interpolation loop. New tracks wrap the interpolation loop by default. - - - - + + Returns the interpolation type of a given track. - - - - + + Returns the amount of keys in a given track. - - - - - - + + + Returns the time at which the key is located. - - - - - - + + + Returns the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]). - - - - - - + + + Returns the value of a given key in a given track. - - - - + + Gets the path of a track. For more information on the path format, see [method track_set_path]. - - - - + + Gets the type of a track. - - - - - - - - - - + + + + + Insert a generic key in a given track. - - - - + + Returns [code]true[/code] if the track at index [code]idx[/code] is enabled. - - - - + + Returns [code]true[/code] if the given track is imported. Else, return [code]false[/code]. - - - - + + Moves a track down. - - - - - - + + + Changes the index position of track [code]idx[/code] to the one defined in [code]to_idx[/code]. - - - - + + Moves a track up. - - - - - - + + + Removes a key by index in a given track. - - - - - - + + + Removes a key by position (seconds) in a given track. - - - - - - + + + Enables/disables the given track. Tracks are enabled by default. - - - - - - + + + Sets the given track as imported or not. - - - - - - + + + If [code]true[/code], the track at [code]idx[/code] wraps the interpolation loop. - - - - - - + + + Sets the interpolation type of a given track. - - - - - - - - + + + + Sets the time of an existing key. - - - - - - - - + + + + Sets the transition curve (easing) for a specific key (see the built-in math function [method @GDScript.ease]). - - - - - - - - + + + + Sets the value of an existing key. - - - - - - + + + Sets the path of a track. Paths must be valid scene-tree paths to a node and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by [code]":"[/code]. For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. - - - - - - + + + Swaps the track [code]idx[/code]'s index position with the track [code]with_idx[/code]. - - - - - - - - - - - - + + + + + + Insert a transform key for a transform track. - - - - - - + + + Returns the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position ([Vector3]), rotation ([Quat]) and scale ([Vector3]). - - - - - - - - + + + + Returns all the key indices of a value track, given a position and delta time. - - - - + + Returns the update mode of a value track. - - - - - - + + + Returns the interpolated value at the given time (in seconds). The [code]track_idx[/code] must be the index of a value track. - - - - - - + + + Sets the update mode (see [enum UpdateMode]) of a value track. diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 7e44b012d46..a1fa4ba7c56 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -12,158 +12,117 @@ - - - - + + Adds an input to the node. This is only useful for nodes created for use in an [AnimationNodeBlendTree]. - - - - - - - - - - - - + + + + + + Blend an animation by [code]blend[/code] amount (name must be valid in the linked [AnimationPlayer]). A [code]time[/code] and [code]delta[/code] may be passed, as well as whether [code]seek[/code] happened. - - - - - - - - - - - - - - + + + + + + + Blend an input. This is only useful for nodes created for an [AnimationNodeBlendTree]. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. A filter mode may be optionally passed (see [enum FilterAction] for options). - - - - - - - - - - - - - - - - + + + + + + + + Blend another animation node (in case this node contains children animation nodes). This function is only useful if you inherit from [AnimationRootNode] instead, else editors will not display your node for addition. - - + Gets the text caption for this node (used by some editors). - - - - + + Gets a child node by index (used by editors inheriting from [AnimationRootNode]). - - + Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode]. - - + Amount of inputs in this node, only useful for nodes that go into [AnimationNodeBlendTree]. - - - - + + Gets the name of an input by index. - - - - + + Gets the value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. - - - - + + Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. - - + Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list]. - - + Returns [code]true[/code] whether you want the blend tree editor to display filter editing on this node. - - - - + + Returns [code]true[/code] whether a given path is filtered. - - - - - - + + + User-defined callback called when a custom node is processed. The [code]time[/code] parameter is a relative delta, unless [code]seek[/code] is [code]true[/code], in which case it is absolute. Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory. @@ -171,32 +130,24 @@ - - - - + + Removes an input, call this only when inactive. - - - - - - + + + Adds or removes a path for the filter. - - - - - - + + + Sets a custom parameter. These are used as local storage, because resources can be reused across the tree or scenes. diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index e14b80e44aa..6b078d0433d 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -14,70 +14,53 @@ - - - - - - - - + + + + Adds a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. - - + Returns the number of points on the blend axis. - - - - + + Returns the [AnimationNode] referenced by the point at index [code]point[/code]. - - - - + + Returns the position of the point at index [code]point[/code]. - - - - + + Removes the point at index [code]point[/code] from the blend axis. - - - - - - + + + Changes the [AnimationNode] referenced by the point at index [code]point[/code]. - - - - - - + + + Updates the position of the point at index [code]point[/code] on the blend axis. diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index eb41cecdf3a..c66baaec26d 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -14,112 +14,84 @@ - - - - - - - - + + + + Adds a new point that represents a [code]node[/code] at the position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. - - - - - - - - - - + + + + + Creates a new triangle using three points [code]x[/code], [code]y[/code], and [code]z[/code]. Triangles can overlap. You can insert the triangle at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array. - - + Returns the number of points in the blend space. - - - - + + Returns the [AnimationRootNode] referenced by the point at index [code]point[/code]. - - - - + + Returns the position of the point at index [code]point[/code]. - - + Returns the number of triangles in the blend space. - - - - - - + + + Returns the position of the point at index [code]point[/code] in the triangle of index [code]triangle[/code]. - - - - + + Removes the point at index [code]point[/code] from the blend space. - - - - + + Removes the triangle at index [code]triangle[/code] from the blend space. - - - - - - + + + Changes the [AnimationNode] referenced by the point at index [code]point[/code]. - - - - - - + + + Updates the position of the point at index [code]point[/code] on the blend axis. diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index 262632dccc6..e3089e89859 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -11,96 +11,71 @@ - - - - - - - - + + + + Adds an [AnimationNode] at the given [code]position[/code]. The [code]name[/code] is used to identify the created sub-node later. - - - - - - - - + + + + Connects the output of an [AnimationNode] as input for another [AnimationNode], at the input port specified by [code]input_index[/code]. - - - - - - + + + Disconnects the node connected to the specified input. - - - - + + Returns the sub-node with the specified [code]name[/code]. - - - - + + Returns the position of the sub-node with the specified [code]name[/code]. - - - - + + Returns [code]true[/code] if a sub-node with specified [code]name[/code] exists. - - - - + + Removes a sub-node. - - - - - - + + + Changes the name of a sub-node. - - - - - - + + + Modifies the position of a sub-node. diff --git a/doc/classes/AnimationNodeOneShot.xml b/doc/classes/AnimationNodeOneShot.xml index 2bc939ed4ec..4c86cff9a5c 100644 --- a/doc/classes/AnimationNodeOneShot.xml +++ b/doc/classes/AnimationNodeOneShot.xml @@ -12,16 +12,13 @@ - - + - - - - + + diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index 04b2e720b03..4038add5f76 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -16,218 +16,167 @@ - - - - - - - - + + + + Adds a new node to the graph. The [code]position[/code] is used for display in the editor. - - - - - - - - + + + + Adds a transition between the given nodes. - - + Returns the graph's end node. - - + Returns the draw offset of the graph. Used for display in the editor. - - - - + + Returns the animation node with the given name. - - - - + + Returns the given animation node's name. - - - - + + Returns the given node's coordinates. Used for display in the editor. - - + Returns the graph's end node. - - - - + + Returns the given transition. - - + Returns the number of connections in the graph. - - - - + + Returns the given transition's start node. - - - - + + Returns the given transition's end node. - - - - + + Returns [code]true[/code] if the graph contains the given node. - - - - - - + + + Returns [code]true[/code] if there is a transition between the given nodes. - - - - + + Deletes the given node from the graph. - - - - - - + + + Deletes the transition between the two specified nodes. - - - - + + Deletes the given transition by index. - - - - - - + + + Renames the given node. - - - - - - + + + Replaces the node and keeps its transitions unchanged. - - - - + + Sets the given node as the graph end point. - - - - + + Sets the draw offset of the graph. Used for display in the editor. - - - - - - + + + Sets the node's coordinates. Used for display in the editor. - - - - + + Sets the given node as the graph start point. diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml index c0fb03c400e..00b6d1b66da 100644 --- a/doc/classes/AnimationNodeStateMachinePlayback.xml +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -16,60 +16,50 @@ - - + - - + Returns the currently playing animation state. - - + Returns the playback position within the current animation state. - - + Returns the current travel path as computed internally by the A* algorithm. - - + Returns [code]true[/code] if an animation is playing. - - - - + + Starts playing the given animation. - - + Stops the currently playing animation. - - - - + + Transitions from the current state to another one, following the shortest path. diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index 9004dd6b96d..3a5486c9a3e 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -13,38 +13,28 @@ - - - - + + - - - - + + - - - - - - + + + - - - - - - + + + diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 6cb9baf3b52..43dafe1eb60 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -15,136 +15,106 @@ - - - - - - + + + Adds [code]animation[/code] to the player accessible with the key [code]name[/code]. - - - - + + Shifts position in the animation timeline and immediately updates the animation. [code]delta[/code] is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled. - - - - + + Returns the name of the next animation in the queue. - - - - - - + + + Triggers the [code]anim_to[/code] animation when the [code]anim_from[/code] animation completes. - - + [AnimationPlayer] caches animated nodes. It may not notice if a node disappears; [method clear_caches] forces it to update the cache again. - - + Clears all queued, unplayed animations. - - - - + + Returns the name of [code]animation[/code] or an empty string if not found. - - - - + + Returns the [Animation] with key [code]name[/code] or [code]null[/code] if not found. - - + Returns the list of stored animation names. - - - - - - + + + Gets the blend time (in seconds) between two animations, referenced by their names. - - + Gets the actual playing speed of current animation or 0 if not playing. This speed is the [member playback_speed] property multiplied by [code]custom_speed[/code] argument specified when calling the [method play] method. - - + Returns a list of the animation names that are currently queued to play. - - - - + + Returns [code]true[/code] if the [AnimationPlayer] stores an [Animation] with key [code]name[/code]. - - + Returns [code]true[/code] if playing an animation. - - - - - - - - - - + + + + + Plays the animation with key [code]name[/code]. Custom blend times and speed can be set. If [code]custom_speed[/code] is negative and [code]from_end[/code] is [code]true[/code], the animation will play backwards (which is equivalent to calling [method play_backwards]). The [AnimationPlayer] keeps track of its current or last played animation with [member assigned_animation]. If this method is called with that same animation [code]name[/code], or with no [code]name[/code] parameter, the assigned animation will resume playing if it was paused, or restart if it was stopped (see [method stop] for both pause and stop). If the animation was already playing, it will keep playing. @@ -152,76 +122,57 @@ - - - - - - + + + Plays the animation with key [code]name[/code] in reverse. This method is a shorthand for [method play] with [code]custom_speed = -1.0[/code] and [code]from_end = true[/code], so see its description for more information. - - - - + + Queues an animation for playback once the current one is done. [b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow. - - - - + + Removes the animation with key [code]name[/code]. - - - - - - + + + Renames an existing animation with key [code]name[/code] to [code]newname[/code]. - - - - - - + + + Seeks the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time. Events between the current frame and [code]seconds[/code] are skipped. - - - - - - - - + + + + Specifies a blend time (in seconds) between two animations, referenced by their names. - - - - + + Stops or pauses the currently playing animation. If [code]reset[/code] is [code]true[/code], the animation position is reset to [code]0[/code] and the playback speed is reset to [code]1.0[/code]. If [code]reset[/code] is [code]false[/code], the [member current_animation_position] will be kept and calling [method play] or [method play_backwards] without arguments or with the same animation name as [member assigned_animation] will resume the animation. @@ -266,24 +217,20 @@ - - - - + + If the currently being played animation changes, this signal will notify of such change. - - + Notifies when an animation finished playing. - - + Notifies when an animation starts playing. diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 1c0892c8488..bc9b6daccb1 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -12,28 +12,22 @@ - - - - + + Manually advance the animations by the specified time (in seconds). - - + Retrieve the motion of the [member root_motion_track] as a [Transform] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation.TYPE_TRANSFORM], returns an identity transformation. See also [member root_motion_track] and [RootMotionView]. - - - - - - + + + diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index d48e887a792..6e7558ddf7c 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -13,116 +13,86 @@ - - - - - - + + + Adds a [code]type[/code] node to the graph with name [code]id[/code]. - - - - + + Shifts position in the animation timeline. [code]delta[/code] is the time in seconds to shift. Events between the current frame and [code]delta[/code] are handled. - - - - + + Returns the [AnimationPlayer]'s [Animation] bound to the [AnimationTreePlayer]'s animation node with name [code]id[/code]. - - - - + + Returns the name of the [member master_player]'s [Animation] bound to this animation node. - - - - + + Returns the absolute playback timestamp of the animation node with name [code]id[/code]. - - - - - - + + + Binds a new [Animation] from the [member master_player] to the [AnimationTreePlayer]'s animation node with name [code]id[/code]. - - - - - - - - + + + + If [code]enable[/code] is [code]true[/code], the animation node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. - - - - - - + + + Binds the [Animation] named [code]source[/code] from [member master_player] to the animation node [code]id[/code]. Recalculates caches. - - - - - - - - + + + + Returns whether node [code]id[/code] and [code]dst_id[/code] are connected at the specified slot. - - - - + + Returns the blend amount of a Blend2 node given its name. - - - - - - + + + Sets the blend amount of a Blend2 node given its name and value. A Blend2 node blends two animations (A and B) with the amount between 0 and 1. @@ -130,34 +100,25 @@ - - - - - - - - + + + + If [code]enable[/code] is [code]true[/code], the Blend2 node with name [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. - - - - + + Returns the blend amount of a Blend3 node given its name. - - - - - - + + + Sets the blend amount of a Blend3 node given its name and value. A Blend3 Node blends three animations (A, B-, B+) with the amount between -1 and 1. @@ -165,21 +126,16 @@ - - - - + + Returns the blend amount of a Blend4 node given its name. - - - - - - + + + Sets the blend amount of a Blend4 node given its name and value. A Blend4 Node blends two pairs of animations. @@ -187,305 +143,231 @@ - - - - - - - - + + + + Connects node [code]id[/code] to [code]dst_id[/code] at the specified input slot. - - - - - - + + + Disconnects nodes connected to [code]id[/code] at the specified input slot. - - + Returns a [PoolStringArray] containing the name of all nodes. - - - - + + Returns the mix amount of a Mix node given its name. - - - - - - + + + Sets the mix amount of a Mix node given its name and value. A Mix node adds input b to input a by the amount given by ratio. - - - - + + Check if a node exists (by name). - - - - + + Returns the input count for a given node. Different types of nodes have different amount of inputs. - - - - - - + + + Returns the input source for a given node input. - - - - + + Returns position of a node in the graph given its name. - - - - + + Gets the node type, will return from [enum NodeType] enum. - - - - - - + + + Renames a node in the graph. - - - - - - + + + Sets the position of a node in the graph given its name and position. - - - - + + Returns the autostart delay of a OneShot node given its name. - - - - + + Returns the autostart random delay of a OneShot node given its name. - - - - + + Returns the fade in time of a OneShot node given its name. - - - - + + Returns the fade out time of a OneShot node given its name. - - - - + + Returns whether a OneShot node will auto restart given its name. - - - - + + Returns whether a OneShot node is active given its name. - - - - - - + + + Sets the autorestart property of a OneShot node given its name and value. - - - - - - + + + Sets the autorestart delay of a OneShot node given its name and value in seconds. - - - - - - + + + Sets the autorestart random delay of a OneShot node given its name and value in seconds. - - - - - - + + + Sets the fade in time of a OneShot node given its name and value in seconds. - - - - - - + + + Sets the fade out time of a OneShot node given its name and value in seconds. - - - - - - - - + + + + If [code]enable[/code] is [code]true[/code], the OneShot node with ID [code]id[/code] turns off the track modifying the property at [code]path[/code]. The modified node's children continue to animate. - - - - + + Starts a OneShot node given its name. - - - - + + Stops the OneShot node with name [code]id[/code]. - - + Manually recalculates the cache of track information generated from animation nodes. Needed when external sources modify the animation nodes' state. - - - - + + Removes the animation node with name [code]id[/code]. - - + Resets this [AnimationTreePlayer]. - - - - + + Returns the time scale value of the TimeScale node with name [code]id[/code]. - - - - - - + + + Sets the time scale of the TimeScale node with name [code]id[/code] to [code]scale[/code]. The TimeScale node is used to speed [Animation]s up if the scale is above 1 or slow them down if it is below 1. @@ -493,108 +375,80 @@ - - - - - - + + + Sets the time seek value of the TimeSeek node with name [code]id[/code] to [code]seconds[/code]. This functions as a seek in the [Animation] or the blend or mix of [Animation]s input in it. - - - - - - + + + Deletes the input at [code]input_idx[/code] for the transition node with name [code]id[/code]. - - - - + + Returns the index of the currently evaluated input for the transition node with name [code]id[/code]. - - - - + + Returns the number of inputs for the transition node with name [code]id[/code]. You can add inputs by right-clicking on the transition node. - - - - + + Returns the cross fade time for the transition node with name [code]id[/code]. - - - - - - + + + Returns [code]true[/code] if the input at [code]input_idx[/code] on the transition node with name [code]id[/code] is set to automatically advance to the next input upon completion. - - - - - - + + + The transition node with name [code]id[/code] sets its current input at [code]input_idx[/code]. - - - - - - - - + + + + The transition node with name [code]id[/code] advances to its next input automatically when the input at [code]input_idx[/code] completes. - - - - - - + + + Resizes the number of inputs available for the transition node with name [code]id[/code]. - - - - - - + + + The transition node with name [code]id[/code] sets its cross fade time to [code]time_sec[/code]. diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index a26234faf17..52c9bb53368 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -12,52 +12,42 @@ - - - - + + Returns an individual bit on the layer mask. - - - - + + Returns an individual bit on the collision mask. - - + Returns a list of intersecting [Area]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. - - + Returns a list of intersecting [PhysicsBody]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. - - - - + + If [code]true[/code], the given area overlaps the Area. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. - - - - + + If [code]true[/code], the given physics body overlaps the Area. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -65,23 +55,17 @@ - - - - - - + + + Set/clear individual bits on the layer mask. This simplifies editing this [Area]'s layers. - - - - - - + + + Set/clear individual bits on the collision mask. This simplifies editing which [Area] layers this [Area] scans. @@ -147,30 +131,24 @@ - - + Emitted when another Area enters this Area. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area. - - + Emitted when another Area exits this Area. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area. - - - - - - - - + + + + Emitted when one of another Area's [Shape]s enters one of this Area's [Shape]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_id[/code] the [RID] of the other Area's [CollisionObject] used by the [PhysicsServer]. @@ -180,14 +158,10 @@ - - - - - - - - + + + + Emitted when one of another Area's [Shape]s enters one of this Area's [Shape]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_id[/code] the [RID] of the other Area's [CollisionObject] used by the [PhysicsServer]. @@ -197,30 +171,24 @@ - - + Emitted when a [PhysicsBody] or [GridMap] enters this Area. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody] or [GridMap]. - - + Emitted when a [PhysicsBody] or [GridMap] exits this Area. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody] or [GridMap]. - - - - - - - - + + + + Emitted when one of a [PhysicsBody] or [GridMap]'s [Shape]s enters one of this Area's [Shape]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s. [code]body_id[/code] the [RID] of the [PhysicsBody] or [MeshLibrary]'s [CollisionObject] used by the [PhysicsServer]. @@ -230,14 +198,10 @@ - - - - - - - - + + + + Emitted when one of a [PhysicsBody] or [GridMap]'s [Shape]s enters one of this Area's [Shape]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s. [code]body_id[/code] the [RID] of the [PhysicsBody] or [MeshLibrary]'s [CollisionObject] used by the [PhysicsServer]. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 08473abef2d..e313556fe55 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -14,52 +14,42 @@ - - - - + + Returns an individual bit on the layer mask. Describes whether other areas will collide with this one on the given layer. - - - - + + Returns an individual bit on the collision mask. Describes whether this area will collide with others on the given layer. - - + Returns a list of intersecting [Area2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. - - + Returns a list of intersecting [PhysicsBody2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead. - - - - + + If [code]true[/code], the given area overlaps the Area2D. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead. - - - - + + If [code]true[/code], the given physics body overlaps the Area2D. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. @@ -67,23 +57,17 @@ - - - - - - + + + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. - - - - - - + + + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. @@ -137,30 +121,24 @@ - - + Emitted when another Area2D enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area2D. - - + Emitted when another Area2D exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area2D. - - - - - - - - + + + + Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [Physics2DServer]. @@ -170,14 +148,10 @@ - - - - - - - - + + + + Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [Physics2DServer]. @@ -187,30 +161,24 @@ - - + Emitted when a [PhysicsBody2D] or [TileMap] enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - - + Emitted when a [PhysicsBody2D] or [TileMap] exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - - - - - - - - + + + + Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [Physics2DServer]. @@ -220,14 +188,10 @@ - - - - - - - - + + + + Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [Physics2DServer]. diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 0cb8820576d..f9dc4dbff79 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -28,78 +28,62 @@ - - - - + + Constructs an array from a [PoolColorArray]. - - - - + + Constructs an array from a [PoolVector3Array]. - - - - + + Constructs an array from a [PoolVector2Array]. - - - - + + Constructs an array from a [PoolStringArray]. - - - - + + Constructs an array from a [PoolRealArray]. - - - - + + Constructs an array from a [PoolIntArray]. - - - - + + Constructs an array from a [PoolByteArray]. - - + Appends an element at the end of the array (alias of [method push_back]). - - + Appends another array at the end of this array. [codeblock] @@ -111,36 +95,27 @@ - - + Returns the last element of the array. Prints an error and returns [code]null[/code] if the array is empty. [b]Note:[/b] Calling this function is not the same as writing [code]array[-1][/code]. If the array is empty, accessing by index will pause project execution when running from the editor. - - - - - - + + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. - - - - - - - - - - + + + + + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method declared in the [code]obj[/code]. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return [code]true[/code] if the first argument is less than the second, and return [code]false[/code] otherwise. [codeblock] @@ -174,34 +149,28 @@ - - - - + + Returns the number of times an element is in the array. - - - - + + Returns a copy of the array. If [code]deep[/code] is [code]true[/code], a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If [code]false[/code], a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array. - - + Returns [code]true[/code] if the array is empty. - - + Removes the first occurrence of a value from the array. To remove an element by index, use [method remove] instead. [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -209,38 +178,30 @@ - - - - - - + + + Searches the array for a value and returns its index or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - - - - + + Searches the array in reverse order for a value and returns its index or [code]-1[/code] if not found. - - + Returns the first element of the array. Prints an error and returns [code]null[/code] if the array is empty. [b]Note:[/b] Calling this function is not the same as writing [code]array[0][/code]. If the array is empty, accessing by index will pause project execution when running from the editor. - - - - + + Returns [code]true[/code] if the array contains the given value. [codeblock] @@ -258,18 +219,15 @@ - - + Returns a hashed integer value representing the array and its contents. [b]Note:[/b] Arrays with equal contents can still produce different hashes. Only the exact same arrays will produce the same hashed integer value. - - - - + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]pos == size()[/code]). [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -282,52 +240,45 @@ - - + Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned. - - + Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned. - - + Removes and returns the last element of the array. Returns [code]null[/code] if the array is empty, without printing an error message. See also [method pop_front]. - - + Removes and returns the first element of the array. Returns [code]null[/code] if the array is empty, without printing an error message. See also [method pop_back]. [b]Note:[/b] On large arrays, this method is much slower than [method pop_back] as it will reindex all the array's elements every time it's called. The larger the array, the slower [method pop_front] will be. - - + Appends an element at the end of the array. See also [method push_front]. - - + Adds an element at the beginning of the array. See also [method push_back]. [b]Note:[/b] On large arrays, this method is much slower than [method push_back] as it will reindex all the array's elements every time it's called. The larger the array, the slower [method push_front] will be. - - + Removes an element from the array by index. If the index does not exist in the array, nothing happens. To remove an element by searching for its value, use [method erase] instead. [b]Note:[/b] This method acts in-place and doesn't return a value. @@ -335,19 +286,15 @@ - - + Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements are [code]null[/code]. - - - - - - + + + Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array. @@ -358,23 +305,17 @@ - - + Returns the number of elements in the array. - - - - - - - - - - + + + + + Duplicates the subset described in the function and returns it in an array, deeply copying the array if [code]deep[/code] is [code]true[/code]. Lower and upper index are inclusive, with the [code]step[/code] describing the change between indices while slicing. @@ -391,10 +332,8 @@ - - - - + + Sorts the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return either [code]true[/code] or [code]false[/code]. For two elements [code]a[/code] and [code]b[/code], if the given method returns [code]true[/code], element [code]b[/code] will be after element [code]a[/code] in the array. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 465be6563a6..b9324726e78 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -30,25 +30,18 @@ - - - - + + Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added. - - - - - - - - - - + + + + + Creates a new surface. Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface. @@ -56,129 +49,100 @@ - - + Removes all blend shapes from this [ArrayMesh]. - - + Returns the number of blend shapes that the [ArrayMesh] holds. - - - - + + Returns the name of the blend shape at this index. - - - - - - + + + Will perform a UV unwrap on the [ArrayMesh] to prepare the mesh for lightmapping. - - + Will regenerate normal maps for the [ArrayMesh]. - - - - + + Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned. - - - - + + Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]). - - - - + + Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]). - - - - + + Returns the format mask of the requested surface (see [method add_surface_from_arrays]). - - - - + + Gets the name assigned to this surface. - - - - + + Returns the primitive type of the requested surface (see [method add_surface_from_arrays]). - - - - + + Removes a surface at position [code]surf_idx[/code], shifting greater surfaces one [code]surf_idx[/code] slot down. - - - - - - + + + Sets a name for a given surface. - - - - - - - - + + + + Updates a specified region of mesh arrays on the GPU. [b]Warning:[/b] Only use if you know what you are doing. You can easily cause crashes by calling this function with improper arguments. diff --git a/doc/classes/AudioEffectCapture.xml b/doc/classes/AudioEffectCapture.xml index c9b37fc64fc..49cdd41df17 100644 --- a/doc/classes/AudioEffectCapture.xml +++ b/doc/classes/AudioEffectCapture.xml @@ -11,55 +11,46 @@ - - - - + + Returns [code]true[/code] if at least [code]frames[/code] audio frames are available to read in the internal ring buffer. - - + Clears the internal ring buffer. - - - - + + Gets the next [code]frames[/code] audio samples from the internal ring buffer. Returns a [PoolVector2Array] containing exactly [code]frames[/code] audio samples if available, or an empty [PoolVector2Array] if insufficient data was available. - - + Returns the total size of the internal ring buffer in frames. - - + Returns the number of audio frames discarded from the audio bus due to full buffer. - - + Returns the number of frames available to read using [method get_buffer]. - - + Returns the number of audio frames inserted from the audio bus. diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 9fe9ed1fa3b..48cd6123f4a 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -10,110 +10,80 @@ - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + diff --git a/doc/classes/AudioEffectEQ.xml b/doc/classes/AudioEffectEQ.xml index b5475310d46..ce798be3613 100644 --- a/doc/classes/AudioEffectEQ.xml +++ b/doc/classes/AudioEffectEQ.xml @@ -11,28 +11,22 @@ - - + Returns the number of bands of the equalizer. - - - - + + Returns the band's gain at the specified index, in dB. - - - - - - + + + Sets band's gain at the specified index, in dB. diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml index 0eedda0c98f..bee9c091db2 100644 --- a/doc/classes/AudioEffectRecord.xml +++ b/doc/classes/AudioEffectRecord.xml @@ -12,24 +12,20 @@ - - + Returns the recorded sample. - - + Returns whether the recording is active or not. - - - - + + If [code]true[/code], the sound will be recorded. Note that restarting the recording will remove the previously recorded sample. diff --git a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml index 7aea128f083..7482e5ae0fe 100644 --- a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml +++ b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml @@ -8,14 +8,10 @@ - - - - - - - - + + + + diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 31a32ee1ef4..99fc11ed53c 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -14,380 +14,291 @@ - - - - + + Adds a bus at [code]at_position[/code]. - - - - - - - - + + + + Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code]. - - + Name of the current device for audio input (see [method capture_get_device_list]). - - + Returns the names of all audio input devices detected on the system. - - - - + + Sets which audio input device is used for audio capture. - - + Generates an [AudioBusLayout] using the available buses and effects. - - - - + + Returns the amount of channels of the bus at index [code]bus_idx[/code]. - - - - - - + + + Returns the [AudioEffect] at position [code]effect_idx[/code] in bus [code]bus_idx[/code]. - - - - + + Returns the number of effects on the bus at [code]bus_idx[/code]. - - - - - - - - + + + + Returns the [AudioEffectInstance] assigned to the given bus and effect indices (and optionally channel). - - - - + + Returns the index of the bus with the name [code]bus_name[/code]. - - - - + + Returns the name of the bus with the index [code]bus_idx[/code]. - - - - - - + + + Returns the peak volume of the left speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code]. - - - - - - + + + Returns the peak volume of the right speaker at bus index [code]bus_idx[/code] and channel index [code]channel[/code]. - - - - + + Returns the name of the bus that the bus at index [code]bus_idx[/code] sends to. - - - - + + Returns the volume of the bus at index [code]bus_idx[/code] in dB. - - + Returns the names of all audio devices detected on the system. - - + Returns the sample rate at the output of the [AudioServer]. - - + Returns the audio driver's output latency. - - + Returns the speaker configuration. - - + Returns the relative time since the last mix occurred. - - + Returns the relative time until the next mix occurs. - - - - + + If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. - - - - - - + + + If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled. - - - - + + If [code]true[/code], the bus at index [code]bus_idx[/code] is muted. - - - - + + If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode. - - + Locks the audio driver's main loop. [b]Note:[/b] Remember to unlock it afterwards. - - - - - - + + + Moves the bus from index [code]index[/code] to index [code]to_index[/code]. - - - - + + Removes the bus at index [code]index[/code]. - - - - - - + + + Removes the effect at index [code]effect_idx[/code] from the bus at index [code]bus_idx[/code]. - - - - - - + + + If [code]true[/code], the bus at index [code]bus_idx[/code] is bypassing effects. - - - - - - - - + + + + If [code]true[/code], the effect at index [code]effect_idx[/code] on the bus at index [code]bus_idx[/code] is enabled. - - - - + + Overwrites the currently used [AudioBusLayout]. - - - - - - + + + If [code]true[/code], the bus at index [code]bus_idx[/code] is muted. - - - - - - + + + Sets the name of the bus at index [code]bus_idx[/code] to [code]name[/code]. - - - - - - + + + Connects the output of the bus at [code]bus_idx[/code] to the bus named [code]send[/code]. - - - - - - + + + If [code]true[/code], the bus at index [code]bus_idx[/code] is in solo mode. - - - - - - + + + Sets the volume of the bus at index [code]bus_idx[/code] to [code]volume_db[/code]. - - - - - - - - + + + + Swaps the position of two effects in bus [code]bus_idx[/code]. - - + Unlocks the audio driver's main loop. (After locking it, you should always unlock it.) diff --git a/doc/classes/AudioStream.xml b/doc/classes/AudioStream.xml index 8845cfcaa5d..4ccd279303b 100644 --- a/doc/classes/AudioStream.xml +++ b/doc/classes/AudioStream.xml @@ -14,8 +14,7 @@ - - + Returns the length of the audio stream in seconds. diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 1b6d6ec0f57..28744a0f86b 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -9,44 +9,35 @@ - - - - + + - - + - - + - - + - - - - + + - - - - + + diff --git a/doc/classes/AudioStreamPlayer.xml b/doc/classes/AudioStreamPlayer.xml index 0489116e3b6..dc0c9819127 100644 --- a/doc/classes/AudioStreamPlayer.xml +++ b/doc/classes/AudioStreamPlayer.xml @@ -17,40 +17,33 @@ - - + Returns the position in the [AudioStream] in seconds. - - + Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer]. - - - - + + Plays the audio from the given [code]from_position[/code], in seconds. - - - - + + Sets the position from which audio will be played, in seconds. - - + Stops the audio. diff --git a/doc/classes/AudioStreamPlayer2D.xml b/doc/classes/AudioStreamPlayer2D.xml index ddf44bb50e3..75de07277dc 100644 --- a/doc/classes/AudioStreamPlayer2D.xml +++ b/doc/classes/AudioStreamPlayer2D.xml @@ -13,40 +13,33 @@ - - + Returns the position in the [AudioStream]. - - + Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer2D]. - - - - + + Plays the audio from the given position [code]from_position[/code], in seconds. - - - - + + Sets the position from which audio will be played, in seconds. - - + Stops the audio. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index fd404f90999..f857e5ca1a1 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -14,40 +14,33 @@ - - + Returns the position in the [AudioStream]. - - + Returns the [AudioStreamPlayback] object associated with this [AudioStreamPlayer3D]. - - - - + + Plays the audio from the given position [code]from_position[/code], in seconds. - - - - + + Sets the position from which audio will be played, in seconds. - - + Stops the audio. diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 6a99e1051ce..159939bc091 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -11,10 +11,8 @@ - - - - + + Saves the AudioStreamSample as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved. [b]Note:[/b] A [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing. diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index d7db0a95e8b..23385f93ae6 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -11,12 +11,9 @@ - - - - - - + + + Bakes the lightmap, scanning from the given [code]from_node[/code] root and saves the resulting [BakedLightmapData] in [code]data_save_path[/code]. If no save path is provided it will try to match the path from the current [member light_data]. diff --git a/doc/classes/BakedLightmapData.xml b/doc/classes/BakedLightmapData.xml index 63024d8a866..514f778ea26 100644 --- a/doc/classes/BakedLightmapData.xml +++ b/doc/classes/BakedLightmapData.xml @@ -8,52 +8,39 @@ - - - - - - - - - - - - + + + + + + - - + - - + - - + - - - - + + - - - - + + diff --git a/doc/classes/BaseButton.xml b/doc/classes/BaseButton.xml index 8d477d25d1f..0750eef55e5 100644 --- a/doc/classes/BaseButton.xml +++ b/doc/classes/BaseButton.xml @@ -10,31 +10,26 @@ - - + Called when the button is pressed. If you need to know the button's pressed state (and [member toggle_mode] is active), use [method _toggled] instead. - - - - + + Called when the button is toggled (only if [member toggle_mode] is active). - - + Returns the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the [enum DrawMode] enum. - - + Returns [code]true[/code] if the mouse has entered the button and has not left it yet. @@ -93,8 +88,7 @@ - - + Emitted when the button was just toggled between pressed and normal states (only if [member toggle_mode] is active). The new state is contained in the [code]button_pressed[/code] argument. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index aae0f2b4723..a66a090c614 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -20,190 +20,150 @@ - - - - + + Constructs a pure rotation basis matrix from the given quaternion. - - - - + + Constructs a pure rotation basis matrix from the given Euler angles (in the YXZ convention: when *composing*, first Y, then X, and Z last), given in the vector format as (X angle, Y angle, Z angle). Consider using the [Quat] constructor instead, which uses a quaternion instead of Euler angles. - - - - - - + + + Constructs a pure rotation basis matrix, rotated around the given [code]axis[/code] by [code]phi[/code], in radians. The axis must be a normalized vector. - - - - - - - - + + + + Constructs a basis matrix from 3 axis vectors (matrix columns). - - + Returns the determinant of the basis matrix. If the basis is uniformly scaled, its determinant is the square of the scale. A negative determinant means the basis has a negative scale. A zero determinant means the basis isn't invertible, and is usually considered invalid. - - + Returns the basis's rotation in the form of Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last). The returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). Consider using the [method get_rotation_quat] method instead, which returns a [Quat] quaternion instead of Euler angles. - - + 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 [GridMap] editor. For further details, refer to the Godot source code. - - + Returns the basis's rotation in the form of a quaternion. See [method get_euler] if you need Euler angles, but keep in mind quaternions should generally be preferred to Euler angles. - - + Assuming that the matrix is the combination of a rotation and scaling, return the absolute value of scaling factors along each axis. - - + Returns the inverse of the matrix. - - - - - - + + + Returns [code]true[/code] if this basis and [code]b[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. [b]Note:[/b] For complicated reasons, the epsilon argument is always discarded. Don't use the epsilon argument, it does nothing. - - + Returns 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 (radians). The axis must be a normalized vector. - - - - + + Introduce an additional scaling specified by the given 3D scaling factor. - - - - - - + + + Assuming that the matrix is a proper rotation matrix, slerp performs a spherical-linear interpolation with another rotation matrix. - - - - + + 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. - - + Returns the transposed version of the matrix. - - - - + + Returns a vector transformed (multiplied) by the matrix. - - - - + + Returns a vector transformed (multiplied) by the transposed basis matrix. [b]Note:[/b] This results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 22b98e9bb7a..fa725ca35ed 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -10,87 +10,66 @@ - - - - + + Creates a bitmap with the specified size, filled with [code]false[/code]. - - - - - - + + + Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to [code]false[/code] if the alpha value of the image at that position is equal to [code]threshold[/code] or less, and [code]true[/code] in other case. - - - - + + Returns bitmap's value at the specified position. - - + Returns bitmap's dimensions. - - + Returns the amount of bitmap elements that are set to [code]true[/code]. - - - - - - + + + Applies morphological dilation to the bitmap. The first argument is the dilation amount, Rect2 is the area where the dilation will be applied. - - - - - - + + + - - - - - - + + + Sets the bitmap's element at the specified position, to the specified value. - - - - - - + + + Sets a rectangular portion of the bitmap to the specified value. diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index 9203880ee8e..853a9ea0794 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -11,83 +11,62 @@ - - - - - - - - - - - - + + + + + + Adds a character to the font, where [code]character[/code] is the Unicode value, [code]texture[/code] is the texture index, [code]rect[/code] is the region in the texture (in pixels!), [code]align[/code] is the (optional) alignment for the character and [code]advance[/code] is the (optional) advance. - - - - - - - - + + + + Adds a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. - - - - + + Adds a texture to the [BitmapFont]. - - + Clears all the font data and settings. - - - - + + Creates a BitmapFont from the [code]*.fnt[/code] file at [code]path[/code]. - - - - - - + + + Returns a kerning pair as a difference. - - - - + + Returns the font atlas texture at index [code]idx[/code]. - - + Returns the number of textures in the BitmapFont atlas. diff --git a/doc/classes/Bone2D.xml b/doc/classes/Bone2D.xml index 125b4184a2b..bc14714a5c5 100644 --- a/doc/classes/Bone2D.xml +++ b/doc/classes/Bone2D.xml @@ -13,22 +13,19 @@ - - + Stores the node's current transforms in [member rest]. - - + Returns the node's index as part of the entire skeleton. See [Skeleton2D]. - - + Returns the node's [member rest] [code]Transform2D[/code] if it doesn't have a parent, or its rest pose relative to its parent. diff --git a/doc/classes/BoxContainer.xml b/doc/classes/BoxContainer.xml index 08c77cdada3..7ce118eab82 100644 --- a/doc/classes/BoxContainer.xml +++ b/doc/classes/BoxContainer.xml @@ -10,10 +10,8 @@ - - - - + + Adds a control to the box as a spacer. If [code]true[/code], [code]begin[/code] will insert the spacer control in front of other children. diff --git a/doc/classes/ButtonGroup.xml b/doc/classes/ButtonGroup.xml index 8d0074a2418..9a1b34db466 100644 --- a/doc/classes/ButtonGroup.xml +++ b/doc/classes/ButtonGroup.xml @@ -11,15 +11,13 @@ - - + Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.group]). - - + Returns the current pressed button. diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index 97086b03383..f56de13bd89 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -12,97 +12,74 @@ - - - - + + Sets this node's properties to match a given [Particles] node with an assigned [ParticlesMaterial]. - - - - + + Returns the base value of the parameter specified by [enum Parameter]. - - - - + + Returns the [Curve] of the parameter specified by [enum Parameter]. - - - - + + Returns the randomness factor of the parameter specified by [enum Parameter]. - - - - + + Returns the enabled state of the given flag (see [enum Flags] for options). - - + Restarts the particle emitter. - - - - - - + + + Sets the base value of the parameter specified by [enum Parameter]. - - - - - - + + + Sets the [Curve] of the parameter specified by [enum Parameter]. - - - - - - + + + Sets the randomness factor of the parameter specified by [enum Parameter]. - - - - - - + + + Enables or disables the given flag (see [enum Flags] for options). diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 26c22df006f..81c342b8cba 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -13,97 +13,74 @@ - - - - + + Sets this node's properties to match a given [Particles2D] node with an assigned [ParticlesMaterial]. - - - - + + Returns the base value of the parameter specified by [enum Parameter]. - - - - + + Returns the [Curve] of the parameter specified by [enum Parameter]. - - - - + + Returns the randomness factor of the parameter specified by [enum Parameter]. - - - - + + Returns the enabled state of the given flag (see [enum Flags] for options). - - + Restarts the particle emitter. - - - - - - + + + Sets the base value of the parameter specified by [enum Parameter]. - - - - - - + + + Sets the [Curve] of the parameter specified by [enum Parameter]. - - - - - - + + + Sets the randomness factor of the parameter specified by [enum Parameter]. - - - - - - + + + Enables or disables the given flag (see [enum Flags] for options). diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index f7cf51b4274..b5462b32ea8 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -11,156 +11,119 @@ - - - - + + If this is the current camera, remove it from being current. If [code]enable_next[/code] is [code]true[/code], request to make the next camera current, if any. - - + Returns the camera's RID from the [VisualServer]. - - + Gets the camera transform. Subclassed cameras such as [InterpolatedCamera] may provide different transforms than the [Node] transform. - - - - + + Returns [code]true[/code] if the given [code]layer[/code] in the [member cull_mask] is enabled, [code]false[/code] otherwise. - - + Returns the camera's frustum planes in world space units as an array of [Plane]s in the following order: near, far, left, top, right, bottom. Not to be confused with [member frustum_offset]. - - - - + + Returns [code]true[/code] if the given position is behind the camera. [b]Note:[/b] A position which returns [code]false[/code] may still be outside the camera's field of view. - - + Makes this camera the current camera for the [Viewport] (see class description). If the camera node is outside the scene tree, it will attempt to become current once it's added. - - - - + + Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. - - - - - - + + + Returns the 3D point in world space that maps to the given 2D coordinate in the [Viewport] rectangle on a plane that is the given [code]z_depth[/code] distance into the scene away from the camera. - - - - + + Returns a normal vector in world space, 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. - - - - + + Returns a 3D position in world space, 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. - - - - - - + + + Enables or disables the given [code]layer[/code] in the [member cull_mask]. - - - - - - - - - - + + + + + Sets the camera projection to frustum mode (see [constant PROJECTION_FRUSTUM]), by specifying a [code]size[/code], an [code]offset[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. - - - - - - - - + + + + Sets the camera projection to orthogonal mode (see [constant PROJECTION_ORTHOGONAL]), by specifying a [code]size[/code], and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.) - - - - - - - - + + + + Sets the camera projection to perspective mode (see [constant PROJECTION_PERSPECTIVE]), by specifying a [code]fov[/code] (field of view) angle in degrees, and the [code]z_near[/code] and [code]z_far[/code] clip planes in world space units. - - - - + + Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in world space. [b]Note:[/b] When using this to position GUI elements over a 3D viewport, use [method is_position_behind] to prevent them from appearing if the 3D point is behind the camera: diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 6911b61ed07..e156089c1f8 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -15,91 +15,74 @@ - - + Aligns the camera to the tracked node. - - + Removes any [Camera2D] from the ancestor [Viewport]'s internal currently-assigned camera. - - + Forces the camera to update scroll immediately. - - + Returns the camera position. - - + Returns the location of the [Camera2D]'s screen-center, relative to the origin. - - - - + + Returns the specified margin. See also [member drag_margin_bottom], [member drag_margin_top], [member drag_margin_left], and [member drag_margin_right]. - - - - + + Returns the specified camera limit. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. - - + Make this the current 2D camera for the scene (viewport and layer), in case there are many cameras in the scene. - - + Sets the camera's position immediately to its current smoothing destination. This has no effect if smoothing is disabled. - - - - - - + + + Sets the specified margin. See also [member drag_margin_bottom], [member drag_margin_top], [member drag_margin_left], and [member drag_margin_right]. - - - - - - + + + Sets the specified camera limit. See also [member limit_bottom], [member limit_top], [member limit_left], and [member limit_right]. diff --git a/doc/classes/CameraFeed.xml b/doc/classes/CameraFeed.xml index 34393111740..5a851f98264 100644 --- a/doc/classes/CameraFeed.xml +++ b/doc/classes/CameraFeed.xml @@ -11,22 +11,19 @@ - - + Returns the unique ID for this feed. - - + Returns the camera's name. - - + Returns the position of camera on the device. diff --git a/doc/classes/CameraServer.xml b/doc/classes/CameraServer.xml index fc01911831b..c398c03ea36 100644 --- a/doc/classes/CameraServer.xml +++ b/doc/classes/CameraServer.xml @@ -11,42 +11,34 @@ - - - - + + Adds a camera feed to the camera server. - - + Returns an array of [CameraFeed]s. - - - - + + Returns the [CameraFeed] with this id. - - + Returns the number of [CameraFeed]s registered. - - - - + + Removes a [CameraFeed]. @@ -54,15 +46,13 @@ - - + Emitted when a [CameraFeed] is added (e.g. webcam is plugged in). - - + Emitted when a [CameraFeed] is removed (e.g. webcam is unplugged). diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 79da1f67afd..68bb62c900e 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -18,284 +18,189 @@ - - + Overridable function called by the engine (if defined) to draw the canvas item. - - - - - - - - - - - - - - - - - - + + + + + + + + + Draws an arc between the given angles. The larger the value of [code]point_count[/code], the smoother the curve. - - - - - - - - - - - - + + + + + + Draws a string character using a custom font. Returns the advance, depending on the character width and kerning with an optional next character. - - - - - - - - + + + + Draws a colored circle. - - - - - - - - - - - - - - + + + + + + + Draws a colored polygon of any amount of points, convex or concave. - - - - - - - - - - - - + + + + + + Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. - - - - - - - - - - - - + + + + + + Draws a [Mesh] in 2D, using the provided texture. See [MeshInstance2D] for related documentation. - - - - - - - - - - + + + + + Draws multiple, parallel lines with a uniform [code]color[/code]. [b]Note:[/b] [code]width[/code] and [code]antialiased[/code] are currently not implemented and have no effect. - - - - - - - - - - + + + + + Draws multiple, parallel lines with a uniform [code]width[/code] and segment-by-segment coloring. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. [b]Note:[/b] [code]width[/code] and [code]antialiased[/code] are currently not implemented and have no effect. - - - - - - - - + + + + Draws a [MultiMesh] in 2D with the provided texture. See [MultiMeshInstance2D] for related documentation. - - - - - - - - - - - - - - + + + + + + + Draws a polygon of any amount of points, convex or concave. - - - - - - - - - - + + + + + Draws interconnected line segments with a uniform [code]color[/code] and [code]width[/code] and optional antialiasing. - - - - - - - - - - + + + + + Draws interconnected line segments with a uniform [code]width[/code], segment-by-segment coloring, and optional antialiasing. Colors assigned to line segments match by index between [code]points[/code] and [code]colors[/code]. - - - - - - - - - - - - - - + + + + + + + Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. - - - - - - - - - - - - + + + + + + Draws a rectangle. If [code]filled[/code] is [code]true[/code], the rectangle will be filled with the [code]color[/code] specified. If [code]filled[/code] is [code]false[/code], the rectangle will be drawn as a stroke with the [code]color[/code] and [code]width[/code] specified. If [code]antialiased[/code] is [code]true[/code], the lines will be antialiased. [b]Note:[/b] [code]width[/code] and [code]antialiased[/code] are only effective if [code]filled[/code] is [code]false[/code]. - - - - - - - - + + + + Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this. - - - - + + Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this. - - - - - - - - - - - - + + + + + + Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width. [b]Example using the default project font:[/b] @@ -310,245 +215,193 @@ - - - - - - + + + Draws a styled rectangle. - - - - - - - - - - + + + + + Draws a texture at a given position. - - - - - - - - - - - - - - + + + + + + + Draws a textured rectangle at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. - - - - - - - - - - - - - - - - + + + + + + + + Draws a textured rectangle region at a given position, optionally modulated by a color. If [code]transpose[/code] is [code]true[/code], the texture will have its X and Y coordinates swapped. - - + Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. - - + Returns the [RID] of the [World2D] canvas where this item is in. - - + Returns the canvas item RID used by [VisualServer] for this item. - - + Returns the transform matrix of this item's canvas. - - + Returns the global position of the mouse. - - + Returns the global transform matrix of this item. - - + Returns the global transform matrix of this item in relation to the canvas. - - + Returns the mouse position relative to this item's position. - - + Returns the transform matrix of this item. - - + Returns the viewport's boundaries as a [Rect2]. - - + Returns this item's transform in relation to the viewport. - - + Returns the [World2D] where this item is in. - - + Hide the [CanvasItem] if it's currently visible. - - + Returns [code]true[/code] if local transform notifications are communicated to children. - - + Returns [code]true[/code] if the node is set as top-level. See [method set_as_toplevel]. - - + Returns [code]true[/code] if global transform notifications are communicated to children. - - + Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree. - - - - + + Assigns [code]screen_point[/code] as this node's new local transform. - - - - + + Transformations issued by [code]event[/code]'s inputs are applied in local space instead of global space. - - - - + + If [code]enable[/code] is [code]true[/code], the node won't inherit its transform from parent canvas items. - - - - + + If [code]enable[/code] is [code]true[/code], children will be updated with local transform data. - - - - + + If [code]enable[/code] is [code]true[/code], children will be updated with global transform data. - - + Show the [CanvasItem] if it's currently hidden. For controls that inherit [Popup], the correct way to make them visible is to call one of the multiple [code]popup*()[/code] functions instead. - - + Queue the [CanvasItem] for update. [constant NOTIFICATION_DRAW] will be called on idle time to request redraw. diff --git a/doc/classes/CanvasLayer.xml b/doc/classes/CanvasLayer.xml index 5c75222a128..a87b39aa608 100644 --- a/doc/classes/CanvasLayer.xml +++ b/doc/classes/CanvasLayer.xml @@ -13,8 +13,7 @@ - - + Returns the RID of the canvas used by this layer. diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index 59135d30016..806f3737390 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -10,208 +10,155 @@ - - - - + + Returns [code]true[/code] if you can instance objects from the specified [code]class[/code], [code]false[/code] in other case. - - - - + + Returns whether the specified [code]class[/code] is available or not. - - - - + + Returns a category associated with the class for use in documentation and the Asset Library. Debug mode required. - - - - - - + + + Returns the value of the integer constant [code]name[/code] of [code]class[/code] or its ancestry. Always returns 0 when the constant could not be found. - - - - - - + + + Returns an array with the names all the integer constants of [code]class[/code] or its ancestry. - - - - - - + + + Returns an array with all the methods of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. [b]Note:[/b] In exported release builds the debug info is not available, so the returned dictionaries will contain only method names. - - - - - - + + + Returns the value of [code]property[/code] of [code]class[/code] or its ancestry. - - - - - - + + + Returns an array with all the properties of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. - - - - - - + + + Returns the [code]signal[/code] data of [code]class[/code] or its ancestry. The returned value is a [Dictionary] with the following keys: [code]args[/code], [code]default_args[/code], [code]flags[/code], [code]id[/code], [code]name[/code], [code]return: (class_name, hint, hint_string, name, type, usage)[/code]. - - - - - - + + + Returns an array with all the signals of [code]class[/code] or its ancestry if [code]no_inheritance[/code] is [code]false[/code]. Every element of the array is a [Dictionary] as described in [method class_get_signal]. - - - - - - + + + Returns whether [code]class[/code] or its ancestry has an integer constant called [code]name[/code] or not. - - - - - - - - + + + + Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not. - - - - - - + + + Returns whether [code]class[/code] or its ancestry has a signal called [code]signal[/code] or not. - - - - - - - - + + + + Sets [code]property[/code] value of [code]class[/code] to [code]value[/code]. - - + Returns the names of all the classes available. - - - - + + Returns the names of all the classes that directly or indirectly inherit from [code]class[/code]. - - - - + + Returns the parent class of [code]class[/code]. - - - - + + Creates an instance of [code]class[/code]. - - - - + + Returns whether this [code]class[/code] is enabled or not. - - - - - - + + + Returns whether [code]inherits[/code] is an ancestor of [code]class[/code] or not. diff --git a/doc/classes/ClippedCamera.xml b/doc/classes/ClippedCamera.xml index 2a703a8422d..a6883237a1d 100644 --- a/doc/classes/ClippedCamera.xml +++ b/doc/classes/ClippedCamera.xml @@ -10,72 +10,57 @@ - - - - + + Adds a collision exception so the camera does not collide with the specified node. - - - - + + Adds a collision exception so the camera does not collide with the specified [RID]. - - + Removes all collision exceptions. - - + Returns the distance the camera has been offset due to a collision. - - - - + + Returns [code]true[/code] if the specified bit index is on. [b]Note:[/b] Bit indices range from 0-19. - - - - + + Removes a collision exception with the specified node. - - - - + + Removes a collision exception with the specified [RID]. - - - - - - + + + Sets the specified bit index to the [code]value[/code]. [b]Note:[/b] Bit indices range from 0-19. diff --git a/doc/classes/CollisionObject.xml b/doc/classes/CollisionObject.xml index 71b794268de..d51767f278b 100644 --- a/doc/classes/CollisionObject.xml +++ b/doc/classes/CollisionObject.xml @@ -10,170 +10,128 @@ - - - - - - - - - - - - + + + + + + Accepts unhandled [InputEvent]s. [code]click_position[/code] is the clicked location in world space and [code]click_normal[/code] is the normal vector extending from the clicked surface of the [Shape] at [code]shape_idx[/code]. Connect to the [code]input_event[/code] signal to easily pick up these events. - - - - + + Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. - - + Returns the object's [RID]. - - + Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument. - - - - + + If [code]true[/code], the shape owner and its shapes are disabled. - - - - + + Removes the given shape owner. - - - - + + Returns the [code]owner_id[/code] of the given shape. - - - - - - + + + Adds a [Shape] to the shape owner. - - - - + + Removes all shapes from the shape owner. - - - - + + Returns the parent object of the given shape owner. - - - - - - + + + Returns the [Shape] with the given id from the given shape owner. - - - - + + Returns the number of shapes the given shape owner contains. - - - - - - + + + Returns the child index of the [Shape] with the given id from the given shape owner. - - - - + + Returns the shape owner's [Transform]. - - - - - - + + + Removes a shape from the given shape owner. - - - - - - + + + If [code]true[/code], disables the given shape owner. - - - - - - + + + Sets the [Transform] of the given shape owner. @@ -189,16 +147,11 @@ - - - - - - - - - - + + + + + Emitted when [method _input_event] receives an event. See its description for details. diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index c959a60edfb..ac7dd388759 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -10,206 +10,156 @@ - - - - - - - - + + + + Accepts unhandled [InputEvent]s. Requires [member input_pickable] to be [code]true[/code]. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events. - - - - + + Creates a new shape owner for the given object. Returns [code]owner_id[/code] of the new owner for future reference. - - + Returns the object's [RID]. - - - - + + Returns the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code]. - - + Returns an [Array] of [code]owner_id[/code] identifiers. You can use these ids in other methods that take [code]owner_id[/code] as an argument. - - - - + + If [code]true[/code], the shape owner and its shapes are disabled. - - - - + + Returns [code]true[/code] if collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s. - - - - + + Removes the given shape owner. - - - - + + Returns the [code]owner_id[/code] of the given shape. - - - - - - + + + Adds a [Shape2D] to the shape owner. - - - - + + Removes all shapes from the shape owner. - - - - + + Returns the parent object of the given shape owner. - - - - - - + + + Returns the [Shape2D] with the given id from the given shape owner. - - - - + + Returns the number of shapes the given shape owner contains. - - - - - - + + + Returns the child index of the [Shape2D] with the given id from the given shape owner. - - - - + + Returns the shape owner's [Transform2D]. - - - - - - + + + Removes a shape from the given shape owner. - - - - - - + + + If [code]true[/code], disables the given shape owner. - - - - - - + + + If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [CollisionObject2D] will not be reported to collided with [CollisionObject2D]s. - - - - - - + + + Sets the [code]one_way_collision_margin[/code] of the shape owner identified by given [code]owner_id[/code] to [code]margin[/code] pixels. - - - - - - + + + Sets the [Transform2D] of the given shape owner. @@ -222,12 +172,9 @@ - - - - - - + + + Emitted when an input event occurs. Requires [member input_pickable] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. See [method _input_event] for details. diff --git a/doc/classes/CollisionShape.xml b/doc/classes/CollisionShape.xml index e89bba6bf7c..d2258567dea 100644 --- a/doc/classes/CollisionShape.xml +++ b/doc/classes/CollisionShape.xml @@ -14,17 +14,14 @@ - - + Sets the collision shape's shape to the addition of all its convexed [MeshInstance] siblings geometry. - - - - + + If this method exists within a script it will be called whenever the shape resource has been modified. diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index 7ce169ed30b..993a0bfa5c3 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -17,10 +17,8 @@ - - - - + + Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also [method @GDScript.ColorN]. [codeblock] @@ -33,10 +31,8 @@ - - - - + + Constructs a color from a 32-bit integer in RGBA format (each byte represents a color channel). [codeblock] @@ -45,14 +41,10 @@ - - - - - - - - + + + + Constructs a color from RGB values, typically between 0 and 1. Alpha will be 1. [codeblock] @@ -61,16 +53,11 @@ - - - - - - - - - - + + + + + Constructs a color from RGBA values, typically between 0 and 1. [codeblock] @@ -79,10 +66,8 @@ - - - - + + Returns a new color resulting from blending this color over another. If the color is opaque, the result is also opaque. The second color may have a range of alpha values. [codeblock] @@ -93,8 +78,7 @@ - - + Returns the most contrasting color. [codeblock] @@ -104,10 +88,8 @@ - - - - + + Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1). [codeblock] @@ -117,16 +99,11 @@ - - - - - - - - - - + + + + + Constructs a color from an HSV profile. [code]h[/code], [code]s[/code], and [code]v[/code] are values between 0 and 1. [codeblock] @@ -135,8 +112,7 @@ - - + Returns the color's grayscale representation. The gray value is calculated as [code](r + g + b) / 3[/code]. @@ -147,8 +123,7 @@ - - + Returns the inverted color [code](1 - r, 1 - g, 1 - b, a)[/code]. [codeblock] @@ -158,19 +133,15 @@ - - - - + + Returns [code]true[/code] if this color and [code]color[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. - - - - + + Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1). [codeblock] @@ -180,12 +151,9 @@ - - - - - - + + + Returns the linear interpolation with another color. The interpolation factor [code]weight[/code] is between 0 and 1. [codeblock] @@ -196,8 +164,7 @@ - - + Returns the color converted to a 32-bit integer in ABGR format (each byte represents a color channel). ABGR is the reversed version of the default format. [codeblock] @@ -207,8 +174,7 @@ - - + Returns the color converted to a 64-bit integer in ABGR format (each word represents a color channel). ABGR is the reversed version of the default format. [codeblock] @@ -218,8 +184,7 @@ - - + Returns the color converted to a 32-bit integer in ARGB format (each byte represents a color channel). ARGB is more compatible with DirectX. [codeblock] @@ -229,8 +194,7 @@ - - + Returns the color converted to a 64-bit integer in ARGB format (each word represents a color channel). ARGB is more compatible with DirectX. [codeblock] @@ -240,10 +204,8 @@ - - - - + + Returns the color's HTML hexadecimal color string in ARGB format (ex: [code]ff34f822[/code]). Setting [code]with_alpha[/code] to [code]false[/code] excludes alpha from the hexadecimal string. @@ -255,8 +217,7 @@ - - + Returns the color converted to a 32-bit integer in RGBA format (each byte represents a color channel). RGBA is Godot's default format. [codeblock] @@ -266,8 +227,7 @@ - - + Returns the color converted to a 64-bit integer in RGBA format (each word represents a color channel). RGBA is Godot's default format. [codeblock] diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 49d3313a672..34ae195dc41 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -11,27 +11,22 @@ - - - - + + Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. [b]Note:[/b] the presets list is only for [i]this[/i] color picker. - - - - + + Removes the given color from the list of color presets of this color picker. - - + Returns the list of colors in the presets of the color picker. @@ -64,22 +59,19 @@ - - + Emitted when the color is changed. - - + Emitted when a preset is added. - - + Emitted when a preset is removed. diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index 1b4d1633bcd..95eba1722d9 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -13,15 +13,13 @@ - - + Returns the [ColorPicker] that this node toggles. - - + Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. @@ -38,8 +36,7 @@ - - + Emitted when the color changes. diff --git a/doc/classes/ConcavePolygonShape.xml b/doc/classes/ConcavePolygonShape.xml index 2761ccb495a..1d23043ef8b 100644 --- a/doc/classes/ConcavePolygonShape.xml +++ b/doc/classes/ConcavePolygonShape.xml @@ -12,17 +12,14 @@ - - + Returns the faces (an array of triangles). - - - - + + Sets the faces (an array of triangles). diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index 25ac28161ca..39cb13118a8 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -12,20 +12,15 @@ - - - - + + - - - - - - + + + diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index 4d4114906c1..7b5e4a29f50 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -32,167 +32,127 @@ - - + - - - - + + Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist. - - - - - - + + + Deletes the specified key in a section. Raises an error if either the section or the key do not exist. - - - - + + Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist. - - + Returns an array of all defined section identifiers. - - - - - - - - + + + + Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback [code]default[/code] value. If [code]default[/code] is not specified or set to [code]null[/code], an error is also raised. - - - - + + Returns [code]true[/code] if the specified section exists. - - - - - - + + + Returns [code]true[/code] if the specified section-key pair exists. - - - - + + Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - - - + + + Loads the encrypted config file specified as a parameter, using the provided [code]key[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - - - + + + Loads the encrypted config file specified as a parameter, using the provided [code]password[/code] to decrypt it. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - + + Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - + + Saves the contents of the [ConfigFile] object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - - - + + + Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]key[/code] to encrypt it. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - - - + + + Saves the contents of the [ConfigFile] object to the AES-256 encrypted file specified as a parameter, using the provided [code]password[/code] to encrypt it. The output file uses an INI-style structure. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - - - - - + + + + Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index 6a00d5122ee..414c0094218 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -14,8 +14,7 @@ - - + Returns the cancel button. diff --git a/doc/classes/Container.xml b/doc/classes/Container.xml index 3498f2fbe3c..9cc12a5c73d 100644 --- a/doc/classes/Container.xml +++ b/doc/classes/Container.xml @@ -11,19 +11,15 @@ - - - - - - + + + Fit a child control in a given rect. This is mainly a helper for creating custom container classes. - - + Queue resort of the contained children. This is called automatically anyway, but can be called upon request. diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index b3f2a203d14..0a43d2644ae 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -21,26 +21,22 @@ - - + Virtual method to be implemented by the user. Returns whether [method _gui_input] should not be called for children controls outside this control's rectangle. Input will be clipped to the Rect of this [Control]. Similar to [member rect_clip_content], but doesn't affect visibility. If not overridden, defaults to [code]false[/code]. - - + Virtual method to be implemented by the user. Returns the minimum size for this control. Alternative to [member rect_min_size] for controlling minimum size via code. The actual minimum size will be the max value of these two (in each axis separately). If not overridden, defaults to [constant Vector2.ZERO]. - - - - + + Virtual method to be implemented by the user. Use this method to process and accept inputs on UI elements. See [method accept_event]. Example: clicking a control. @@ -59,10 +55,8 @@ - - - - + + Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [code]for_text[/code] includes the contents of the [member hint_tooltip] property. The returned node must be of type [Control] or Control-derived. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance (if you want to use a pre-existing node from your scene tree, you can duplicate it and pass the duplicated instance). When [code]null[/code] or a non-Control node is returned, the default tooltip will be used instead. @@ -85,19 +79,15 @@ - - + Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input]. - - - - - - + + + Overrides the [Color] with given [code]name[/code] in the [member theme] resource the control uses. [b]Note:[/b] Unlike other theme overrides, there is no way to undo a color override without manually assigning the previous color. @@ -113,56 +103,41 @@ - - - - - - + + + Overrides an integer constant with given [code]name[/code] in the [member theme] resource the control uses. If the [code]constant[/code] is [code]0[/code], the override is cleared and the constant from assigned [Theme] is used. - - - - - - + + + Overrides the font with given [code]name[/code] in the [member theme] resource the control uses. If [code]font[/code] is [code]null[/code] or invalid, the override is cleared and the font from assigned [Theme] is used. - - - - - - + + + Overrides the icon with given [code]name[/code] in the [member theme] resource the control uses. If [code]icon[/code] is [code]null[/code] or invalid, the override is cleared and the icon from assigned [Theme] is used. - - - - - - + + + Overrides the [Shader] with given [code]name[/code] in the [member theme] resource the control uses. If [code]shader[/code] is [code]null[/code] or invalid, the override is cleared and the shader from assigned [Theme] is used. - - - - - - + + + Overrides the [StyleBox] with given [code]name[/code] in the [member theme] resource the control uses. If [code]stylebox[/code] is empty or invalid, the override is cleared and the [StyleBox] from assigned [Theme] is used. [b]Example of modifying a property in a StyleBox by duplicating it:[/b] @@ -181,12 +156,9 @@ - - - - - - + + + Godot calls this method to test if [code]data[/code] from a control's [method get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control. This method should only be used to test the data. Process the data in [method drop_data]. @@ -199,12 +171,9 @@ - - - - - - + + + Godot calls this method to pass you the [code]data[/code] from a control's [method get_drag_data] result. Godot first calls [method can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. [codeblock] @@ -217,54 +186,43 @@ - - + Finds the next (below in the tree) [Control] that can receive the focus. - - + Finds the previous (above in the tree) [Control] that can receive the focus. - - - - - - + + + Forces drag and bypasses [method get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control. The methods [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data. - - - - + + Returns the anchor identified by [code]margin[/code] constant from [enum Margin] enum. A getter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. - - + Returns [member margin_left] and [member margin_top]. See also [member rect_position]. - - - - - - + + + Returns a color from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]node_type[/code]. [codeblock] @@ -274,37 +232,29 @@ - - + Returns combined minimum size from [member rect_min_size] and [method get_minimum_size]. - - - - - - + + + Returns a constant from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]node_type[/code]. - - - - + + Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape]. - - - - + + Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method can_drop_data] and [method drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag]. A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. @@ -317,124 +267,100 @@ - - + Returns [member margin_right] and [member margin_bottom]. - - - - + + Returns the focus neighbour identified by [code]margin[/code] constant from [enum Margin] enum. A getter method for [member focus_neighbour_bottom], [member focus_neighbour_left], [member focus_neighbour_right] and [member focus_neighbour_top]. - - + Returns the control that has the keyboard focus or [code]null[/code] if none. - - - - - - + + + Returns a font from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]node_type[/code]. - - + Returns the position and size of the control relative to the top-left corner of the screen. See [member rect_position] and [member rect_size]. - - - - - - + + + Returns an icon from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]node_type[/code]. - - - - + + Returns the anchor identified by [code]margin[/code] constant from [enum Margin] enum. A getter method for [member margin_bottom], [member margin_left], [member margin_right] and [member margin_top]. - - + Returns the minimum size for this control. See [member rect_min_size]. - - + Returns the width/height occupied in the parent control. - - + Returns the parent control node. - - + Returns the position and size of the control relative to the top-left corner of the parent Control. See [member rect_position] and [member rect_size]. - - + Returns the rotation (in radians). - - - - - - + + + Returns a [StyleBox] from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]node_type[/code]. - - - - + + Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip]. - - + Creates an [InputEventMouseButton] that attempts to click the control. If the event is received, the control acquires focus. [codeblock] @@ -444,104 +370,80 @@ - - + Steal the focus from another control and become the focused control (see [member focus_mode]). - - - - - - + + + Returns [code]true[/code] if [Color] with given [code]name[/code] and associated with [Control] of given [code]node_type[/code] exists in assigned [Theme]. - - - - + + Returns [code]true[/code] if [Color] with given [code]name[/code] has a valid override in this [Control] node. - - - - - - + + + Returns [code]true[/code] if constant with given [code]name[/code] and associated with [Control] of given [code]node_type[/code] exists in assigned [Theme]. - - - - + + Returns [code]true[/code] if constant with given [code]name[/code] has a valid override in this [Control] node. - - + Returns [code]true[/code] if this is the current focused control. See [member focus_mode]. - - - - - - + + + Returns [code]true[/code] if font with given [code]name[/code] and associated with [Control] of given [code]node_type[/code] exists in assigned [Theme]. - - - - + + Returns [code]true[/code] if font with given [code]name[/code] has a valid override in this [Control] node. - - - - - - + + + Returns [code]true[/code] if icon with given [code]name[/code] and associated with [Control] of given [code]node_type[/code] exists in assigned [Theme]. - - - - + + Returns [code]true[/code] if icon with given [code]name[/code] has a valid override in this [Control] node. - - - - + + Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control. If not overridden, default behavior is checking if the point is within control's Rect. @@ -549,59 +451,45 @@ - - - - + + Returns [code]true[/code] if [Shader] with given [code]name[/code] has a valid override in this [Control] node. - - - - - - + + + Returns [code]true[/code] if [StyleBox] with given [code]name[/code] and associated with [Control] of given [code]node_type[/code] exists in assigned [Theme]. - - - - + + Returns [code]true[/code] if [StyleBox] with given [code]name[/code] has a valid override in this [Control] node. - - + Invalidates the size cache in this node and in parent nodes up to toplevel. Intended to be used with [method get_minimum_size] when the return value is changed. Setting [member rect_min_size] directly calls this method automatically. - - + Give up the focus. No other control will be able to receive keyboard input. - - - - - - - - - - + + + + + Sets the anchor identified by [code]margin[/code] constant from [enum Margin] enum to value [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top]. If [code]keep_margin[/code] is [code]true[/code], margins aren't updated after this operation. @@ -609,59 +497,43 @@ - - - - - - - - - - + + + + + Works the same as [method set_anchor], but instead of [code]keep_margin[/code] argument and automatic update of margin, it allows to set the margin offset yourself (see [method set_margin]). - - - - - - - - + + + + Sets both anchor preset and margin preset. See [method set_anchors_preset] and [method set_margins_preset]. - - - - - - + + + Sets the anchors to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. If [code]keep_margins[/code] is [code]true[/code], control's position will also be updated. - - - - + + Sets [member margin_left] and [member margin_top] at the same time. Equivalent of changing [member rect_position]. - - - - + + Forwards the handling of this control's drag and drop to [code]target[/code] control. Forwarding can be implemented in the target control similar to the methods [method get_drag_data], [method can_drop_data], and [method drop_data] but with two differences: @@ -688,10 +560,8 @@ - - - - + + Shows the given control at the mouse pointer. A good time to call this method is in [method get_drag_data]. The control must not be in the scene tree. You should not free the control, and you should not keep a reference to the control beyond the duration of the drag. It will be deleted automatically after the drag has ended. [codeblock] @@ -708,57 +578,42 @@ - - - - + + Sets [member margin_right] and [member margin_bottom] at the same time. - - - - - - + + + Sets the anchor identified by [code]margin[/code] constant from [enum Margin] enum to [Control] at [code]neighbor[/code] node path. A setter method for [member focus_neighbour_bottom], [member focus_neighbour_left], [member focus_neighbour_right] and [member focus_neighbour_top]. - - - - - - + + + Sets the [member rect_global_position] to given [code]position[/code]. If [code]keep_margins[/code] is [code]true[/code], control's anchors will be updated instead of margins. - - - - - - + + + Sets the margin identified by [code]margin[/code] constant from [enum Margin] enum to given [code]offset[/code]. A setter method for [member margin_bottom], [member margin_left], [member margin_right] and [member margin_top]. - - - - - - - - + + + + Sets the margins to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor. Use parameter [code]resize_mode[/code] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code]. @@ -766,53 +621,41 @@ - - - - - - + + + Sets the [member rect_position] to given [code]position[/code]. If [code]keep_margins[/code] is [code]true[/code], control's anchors will be updated instead of margins. - - - - + + Sets the rotation (in radians). - - - - - - + + + Sets the size (see [member rect_size]). If [code]keep_margins[/code] is [code]true[/code], control's anchors will be updated instead of margins. - - - - + + Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. If [code]exclusive[/code] is [code]true[/code], other controls will not receive input and clicking outside this control will not close it. - - - - + + Moves the mouse cursor to [code]to_position[/code], relative to [member rect_position] of this [Control]. @@ -950,8 +793,7 @@ - - + Emitted when the node receives an [InputEvent]. diff --git a/doc/classes/ConvexPolygonShape2D.xml b/doc/classes/ConvexPolygonShape2D.xml index dd44423256a..b10450f7ad4 100644 --- a/doc/classes/ConvexPolygonShape2D.xml +++ b/doc/classes/ConvexPolygonShape2D.xml @@ -11,10 +11,8 @@ - - - - + + Based on the set of points provided, this creates and assigns the [member points] property using the convex hull algorithm. Removing all unneeded points. See [method Geometry.convex_hull_2d] for details. diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml index 8a91e05a661..4d1b67782c4 100644 --- a/doc/classes/Crypto.xml +++ b/doc/classes/Crypto.xml @@ -28,34 +28,25 @@ - - - - + + Generates a [PoolByteArray] of cryptographically secure random bytes with given [code]size[/code]. - - - - + + Generates an RSA [CryptoKey] that can be used for creating self-signed certificates and passed to [method StreamPeerSSL.accept_stream]. - - - - - - - - - - + + + + + Generates a self-signed [X509Certificate] from the given [CryptoKey] and [code]issuer_name[/code]. The certificate validity will be defined by [code]not_before[/code] and [code]not_after[/code] (first valid date and last valid date). The [code]issuer_name[/code] must contain at least "CN=" (common name, i.e. the domain name), "O=" (organization, i.e. your company name), "C=" (country, i.e. 2 lettered ISO-3166 code of the country the organization is based in). A small example to generate an RSA key and a X509 self-signed certificate. diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml index dd4fb8524c6..ec5cd57293c 100644 --- a/doc/classes/CryptoKey.xml +++ b/doc/classes/CryptoKey.xml @@ -12,19 +12,15 @@ - - - - + + Loads a key from [code]path[/code] ("*.key" file). - - - - + + Saves a key to the given [code]path[/code] (should be a "*.key" file). diff --git a/doc/classes/CubeMap.xml b/doc/classes/CubeMap.xml index e65503d63a0..481119d64f5 100644 --- a/doc/classes/CubeMap.xml +++ b/doc/classes/CubeMap.xml @@ -10,35 +10,28 @@ - - + Returns the [CubeMap]'s height. - - - - + + Returns an [Image] for a side of the [CubeMap] using one of the [enum Side] constants. - - + Returns the [CubeMap]'s width. - - - - - - + + + Sets an [Image] for a side of the [CubeMap] using one of the [enum Side] constants. diff --git a/doc/classes/Curve.xml b/doc/classes/Curve.xml index 137302b7205..fd03a087a2f 100644 --- a/doc/classes/Curve.xml +++ b/doc/classes/Curve.xml @@ -10,184 +10,140 @@ - - - - - - - - - - - - + + + + + + Adds a point to the curve. For each side, if the [code]*_mode[/code] is [constant TANGENT_LINEAR], the [code]*_tangent[/code] angle (in degrees) uses the slope of the curve halfway to the adjacent point. Allows custom assignments to the [code]*_tangent[/code] angle if [code]*_mode[/code] is set to [constant TANGENT_FREE]. - - + Recomputes the baked cache of points for the curve. - - + Removes points that are closer than [code]CMP_EPSILON[/code] (0.00001) units to their neighbor on the curve. - - + Removes all points from the curve. - - + Returns the number of points describing the curve. - - - - + + Returns the left [enum TangentMode] for the point at [code]index[/code]. - - - - + + Returns the left tangent angle (in degrees) for the point at [code]index[/code]. - - - - + + Returns the curve coordinates for the point at [code]index[/code]. - - - - + + Returns the right [enum TangentMode] for the point at [code]index[/code]. - - - - + + Returns the right tangent angle (in degrees) for the point at [code]index[/code]. - - - - + + Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve. - - - - + + Returns the Y value for the point that would exist at the X position [code]offset[/code] along the curve using the baked cache. Bakes the curve's points if not already baked. - - - - + + Removes the point at [code]index[/code] from the curve. - - - - - - + + + Sets the left [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. - - - - - - + + + Sets the left tangent angle for the point at [code]index[/code] to [code]tangent[/code]. - - - - - - + + + Sets the offset from [code]0.5[/code]. - - - - - - + + + Sets the right [enum TangentMode] for the point at [code]index[/code] to [code]mode[/code]. - - - - - - + + + Sets the right tangent angle for the point at [code]index[/code] to [code]tangent[/code]. - - - - - - + + + Assigns the vertical position [code]y[/code] to the point at [code]index[/code]. diff --git a/doc/classes/Curve2D.xml b/doc/classes/Curve2D.xml index 384e99bf9ba..28c8daa1942 100644 --- a/doc/classes/Curve2D.xml +++ b/doc/classes/Curve2D.xml @@ -11,115 +11,90 @@ - - - - - - - - - - + + + + + Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code]. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. - - + Removes all points from the curve. - - + Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough. - - + Returns the cache of points as a [PoolVector2Array]. - - - - + + Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked]. [code]to_point[/code] must be in this curve's local space. - - - - + + Returns the closest baked point (in curve's local space) to [code]to_point[/code]. [code]to_point[/code] must be in this curve's local space. - - + Returns the number of points describing the curve. - - - - + + Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. - - - - + + Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. - - - - + + Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0)[/code]. - - - - - - + + + Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 >= t <=1[/code]) give strange, but predictable results. If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0)[/code]. - - - - - - + + + Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a pixel distance along the curve. To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. @@ -127,63 +102,47 @@ - - - - + + Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code]. - - - - + + Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. - - - - - - + + + Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. - - - - - - + + + Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. - - - - - - + + + Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. - - - - - - + + + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 3a1e07f1149..202904d8d81 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -11,139 +11,110 @@ - - - - - - - - - - + + + + + Adds a point to a curve at [code]position[/code], with control points [code]in[/code] and [code]out[/code]. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position <0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. - - + Removes all points from the curve. - - + Returns the total length of the curve, based on the cached points. Given enough density (see [member bake_interval]), it should be approximate enough. - - + Returns the cache of points as a [PoolVector3Array]. - - + Returns the cache of tilts as a [PoolRealArray]. - - + Returns the cache of up vectors as a [PoolVector3Array]. If [member up_vector_enabled] is [code]false[/code], the cache will be empty. - - - - + + Returns the closest offset to [code]to_point[/code]. This offset is meant to be used in [method interpolate_baked] or [method interpolate_baked_up_vector]. [code]to_point[/code] must be in this curve's local space. - - - - + + Returns the closest baked point (in curve's local space) to [code]to_point[/code]. [code]to_point[/code] must be in this curve's local space. - - + Returns the number of points describing the curve. - - - - + + Returns the position of the control point leading to the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. - - - - + + Returns the position of the control point leading out of the vertex [code]idx[/code]. The returned position is relative to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. - - - - + + Returns the position of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. - - - - + + Returns the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console, and returns [code]0[/code]. - - - - - - + + + Returns the position between the vertex [code]idx[/code] and the vertex [code]idx + 1[/code], where [code]t[/code] controls if the point is the first vertex ([code]t = 0.0[/code]), the last vertex ([code]t = 1.0[/code]), or in between. Values of [code]t[/code] outside the range ([code]0.0 >= t <=1[/code]) give strange, but predictable results. If [code]idx[/code] is out of bounds it is truncated to the first or last vertex, and [code]t[/code] is ignored. If the curve has no points, the function sends an error to the console, and returns [code](0, 0, 0)[/code]. - - - - - - + + + Returns a point within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. To do that, it finds the two cached points where the [code]offset[/code] lies between, then interpolates the values. This interpolation is cubic if [code]cubic[/code] is set to [code]true[/code], or linear if set to [code]false[/code]. @@ -151,12 +122,9 @@ - - - - - - + + + Returns an up vector within the curve at position [code]offset[/code], where [code]offset[/code] is measured as a distance in 3D units along the curve. To do that, it finds the two cached up vectors where the [code]offset[/code] lies between, then interpolates the values. If [code]apply_tilt[/code] is [code]true[/code], an interpolated tilt is applied to the interpolated up vector. @@ -164,75 +132,56 @@ - - - - + + Returns the position at the vertex [code]fofs[/code]. It calls [method interpolate] using the integer part of [code]fofs[/code] as [code]idx[/code], and its fractional part as [code]t[/code]. - - - - + + Deletes the point [code]idx[/code] from the curve. Sends an error to the console if [code]idx[/code] is out of bounds. - - - - - - + + + Sets the position of the control point leading to the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. - - - - - - + + + Sets the position of the control point leading out of the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The position is relative to the vertex. - - - - - - + + + Sets the position for the vertex [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. - - - - - - + + + Sets the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the [PathFollow] calculates. - - - - - - + + + Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts. This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough. diff --git a/doc/classes/DTLSServer.xml b/doc/classes/DTLSServer.xml index b70ab23bb1d..db573761a91 100644 --- a/doc/classes/DTLSServer.xml +++ b/doc/classes/DTLSServer.xml @@ -62,23 +62,17 @@ - - - - - - - - + + + + Setup the DTLS server to use the given [code]private_key[/code] and provide the given [code]certificate[/code] to clients. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. - - - - + + Try to initiate the DTLS handshake with the given [code]udp_peer[/code] which must be already connected (see [method PacketPeerUDP.connect_to_host]). [b]Note[/b]: You must check that the state of the return PacketPeerUDP is [constant PacketPeerDTLS.STATUS_HANDSHAKING], as it is normal that 50% of the new connections will be invalid due to cookie exchange. diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index a2bb3cc0a91..07681d207d0 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -95,46 +95,36 @@ - - - - + + Creates a copy of the dictionary, and returns it. The [code]deep[/code] parameter causes inner dictionaries and arrays to be copied recursively, but does not apply to objects. - - + Returns [code]true[/code] if the dictionary is empty. - - - - + + Erase a dictionary key/value pair by key. Returns [code]true[/code] if the given key was present in the dictionary, [code]false[/code] otherwise. Does not erase elements while iterating over the dictionary. - - - - - - + + + Returns the current value for the specified key in the [Dictionary]. If the key does not exist, the method returns the value of the optional default argument, or [code]null[/code] if it is omitted. - - - - + + Returns [code]true[/code] if the dictionary has a given key. [b]Note:[/b] This is equivalent to using the [code]in[/code] operator as follows: @@ -147,17 +137,14 @@ - - - - + + Returns [code]true[/code] if the dictionary has all the keys in the given array. - - + Returns a hashed integer value representing the dictionary contents. This can be used to compare dictionaries by value: [codeblock] @@ -170,22 +157,19 @@ - - + Returns the list of keys in the [Dictionary]. - - + Returns the number of keys in the dictionary. - - + Returns the list of values in the [Dictionary]. diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index 89de9aa7b19..27caaccfdbf 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -29,104 +29,84 @@ - - - - + + Changes the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - - - + + + Copies the [code]from[/code] file to the [code]to[/code] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - + Returns whether the current item processed with the last [method get_next] call is a directory ([code].[/code] and [code]..[/code] are considered directories). - - - - + + Returns whether the target directory exists. The argument can be relative to the current directory, or an absolute path. - - - - + + Returns whether the target file exists. The argument can be relative to the current directory, or an absolute path. - - + Returns the absolute path to the currently opened directory (e.g. [code]res://folder[/code] or [code]C:\tmp\folder[/code]). - - + Returns the currently opened directory's drive index. See [method get_drive] to convert returned index to the name of the drive. - - - - + + On Windows, returns the name of the drive (partition) passed as an argument (e.g. [code]C:[/code]). On other platforms, or if the requested drive does not exist, the method returns an empty String. - - + On Windows, returns the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0. - - + Returns 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). - - + On UNIX desktop systems, returns the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1. - - - - - - + + + Initializes the stream used to list all files and directories using the [method get_next] function, closing the currently opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. If [code]skip_navigational[/code] is [code]true[/code], [code].[/code] and [code]..[/code] are filtered out. @@ -134,59 +114,47 @@ - - + Closes the current stream opened with [method list_dir_begin] (whether it has been fully processed with [method get_next] does not matter). - - - - + + Creates a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - + + Creates a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - + + Opens an existing directory of the filesystem. The [code]path[/code] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]). Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - + + Deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. Returns one of the [enum Error] code constants ([code]OK[/code] on success). - - - - - - + + + Renames (move) the [code]from[/code] file to the [code]to[/code] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten. Returns one of the [enum Error] code constants ([code]OK[/code] on success). diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index ccabc8c01f1..4a5f3ecc1e3 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -19,74 +19,58 @@ - - - - + + Adds a fallback font. - - + Returns a string containing all the characters available in the main and all the fallback fonts. If a given character is included in more than one font, it appears only once in the returned string. - - - - + + Returns the fallback font at index [code]idx[/code]. - - + Returns the number of fallback fonts. - - - - + + Returns the spacing for the given [code]type[/code] (see [enum SpacingType]). - - - - + + Removes the fallback font at index [code]idx[/code]. - - - - - - + + + Sets the fallback font at index [code]idx[/code]. - - - - - - + + + Sets the spacing for [code]type[/code] (see [enum SpacingType]) to [code]value[/code] in pixels (not relative to the font size). diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index 4a5507d3e91..1c1d0369c54 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -10,77 +10,57 @@ - - - - - - - - - - + + + + + Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. [code]features[/code] is the list of features for the export, [code]is_debug[/code] is [code]true[/code] for debug builds, [code]path[/code] is the target path for the exported project. [code]flags[/code] is only used when running a runnable profile, e.g. when using native run on Android. - - + Virtual method to be overridden by the user. Called when the export is finished. - - - - - - - - + + + + Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. [code]path[/code] is the path of the file, [code]type[/code] is the [Resource] represented by the file (e.g. [PackedScene]) and [code]features[/code] is the list of features for the export. Calling [method skip] inside this callback will make the file not included in the export. - - - - - - - - + + + + Adds a custom file to be exported. [code]path[/code] is the virtual path that can be used to load the file, [code]file[/code] is the binary data of the file. If [code]remap[/code] is [code]true[/code], file will not be exported, but instead remapped to the given [code]path[/code]. - - - - + + Adds an iOS bundle file from the given [code]path[/code] to the exported project. - - - - + + Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin. - - - - + + Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary. [b]Note:[/b] For static libraries (*.a) works in same way as [method add_ios_framework]. @@ -88,55 +68,43 @@ - - - - + + Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project. - - - - + + Adds linker flags for the iOS export. - - - - + + Adds content for iOS Property List files. - - - - + + Adds a static lib from the given [code]path[/code] to the iOS project. - - - - - - + + + Adds a shared object with the given [code]tags[/code] and destination [code]path[/code]. - - + To be called inside [method _export_file]. Skips the current file, so it's not included in the export. diff --git a/doc/classes/EditorFeatureProfile.xml b/doc/classes/EditorFeatureProfile.xml index 83789d0efa2..88857731cad 100644 --- a/doc/classes/EditorFeatureProfile.xml +++ b/doc/classes/EditorFeatureProfile.xml @@ -11,112 +11,84 @@ - - - - + + Returns the specified [code]feature[/code]'s human-readable name. - - - - + + Returns [code]true[/code] if the class specified by [code]class_name[/code] is disabled. When disabled, the class won't appear in the Create New Node dialog. - - - - + + Returns [code]true[/code] if editing for the class specified by [code]class_name[/code] is disabled. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. - - - - - - + + + Returns [code]true[/code] if [code]property[/code] is disabled in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code]. - - - - + + Returns [code]true[/code] if the [code]feature[/code] is disabled. When a feature is disabled, it will disappear from the editor entirely. - - - - + + Loads an editor feature profile from a file. The file must follow the JSON format obtained by using the feature profile manager's [b]Export[/b] button or the [method save_to_file] method. - - - - + + Saves the editor feature profile to a file in JSON format. It can then be imported using the feature profile manager's [b]Import[/b] button or the [method load_from_file] button. - - - - - - + + + If [code]disable[/code] is [code]true[/code], disables the class specified by [code]class_name[/code]. When disabled, the class won't appear in the Create New Node dialog. - - - - - - + + + If [code]disable[/code] is [code]true[/code], disables editing for the class specified by [code]class_name[/code]. When disabled, the class will still appear in the Create New Node dialog but the inspector will be read-only when selecting a node that extends the class. - - - - - - - - + + + + If [code]disable[/code] is [code]true[/code], disables editing for [code]property[/code] in the class specified by [code]class_name[/code]. When a property is disabled, it won't appear in the inspector when selecting a node that extends the class specified by [code]class_name[/code]. - - - - - - + + + If [code]disable[/code] is [code]true[/code], disables the editor feature specified in [code]feature[/code]. When a feature is disabled, it will disappear from the editor entirely. diff --git a/doc/classes/EditorFileDialog.xml b/doc/classes/EditorFileDialog.xml index ee5e5da830d..9b697e1fbed 100644 --- a/doc/classes/EditorFileDialog.xml +++ b/doc/classes/EditorFileDialog.xml @@ -9,32 +9,27 @@ - - - - + + Adds a comma-delimited file extension filter option to the [EditorFileDialog] with an optional semi-colon-delimited label. For example, [code]"*.tscn, *.scn; Scenes"[/code] results in filter text "Scenes (*.tscn, *.scn)". - - + Removes all filters except for "All Files (*)". - - + Returns the [code]VBoxContainer[/code] used to display the file system. - - + Notify the [EditorFileDialog] that its view of the data is no longer accurate. Updates the view contents on next view update. @@ -71,22 +66,19 @@ - - + Emitted when a directory is selected. - - + Emitted when a file is selected. - - + Emitted when multiple files are selected. diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index 30a7a4ed7ba..5a9457efb0c 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -11,70 +11,58 @@ - - - - + + Gets the type of the file, given the full path. - - + Gets the root directory object. - - - - + + Returns a view into the filesystem at [code]path[/code]. - - + Returns the scan progress for 0 to 1 if the FS is being scanned. - - + Returns [code]true[/code] of the filesystem is being scanned. - - + Scan the filesystem for changes. - - + Check if the source of any imported resource changed. - - - - + + Update a file information. Call this if an external program (not Godot) modified the file. - - + Scans the script files and updates the list of custom class names. @@ -87,22 +75,19 @@ - - + Emitted if a resource is reimported. - - + Emitted if at least one resource is reloaded when the filesystem is scanned. - - + Emitted if the source of any imported file changed. diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 16bc44460e0..35b590d1287 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -10,117 +10,94 @@ - - - - + + Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found. - - - - + + Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found. - - - - + + Returns the name of the file at index [code]idx[/code]. - - + Returns the number of files in this directory. - - - - + + Returns [code]true[/code] if the file at index [code]idx[/code] imported properly. - - - - + + Returns the path to the file at index [code]idx[/code]. - - - - + + Returns the base class of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. - - - - + + Returns the name of the script class defined in the file at index [code]idx[/code]. If the file doesn't define a script class using the [code]class_name[/code] syntax, this will return an empty string. - - - - + + Returns the file extension of the file at index [code]idx[/code]. - - + Returns the name of this directory. - - + Returns the parent directory for this directory or [code]null[/code] if called on a directory at [code]res://[/code] or [code]user://[/code]. - - + Returns the path to this directory. - - - - + + Returns the subdirectory at index [code]idx[/code]. - - + Returns the number of subdirectories in this directory. diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 51a81ac2b2a..238cc4f062b 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -52,35 +52,28 @@ - - - - + + Gets the options and default values for the preset at this index. Returns an Array of Dictionaries with the following keys: [code]name[/code], [code]default_value[/code], [code]property_hint[/code] (optional), [code]hint_string[/code] (optional), [code]usage[/code] (optional). - - + Gets the order of this importer to be run when importing resources. Higher values will be called later. Use this to ensure the importer runs after the dependencies are already imported. - - + Gets the unique name of the importer. - - - - - - + + + This method can be overridden to hide specific import options if conditions are met. This is mainly useful for hiding options that depend on others if one of them is disabled. For example: [codeblock] @@ -95,69 +88,55 @@ - - + Gets the number of initial presets defined by the plugin. Use [method get_import_options] to get the default options for the preset and [method get_preset_name] to get the name of the preset. - - - - + + Gets the name of the options preset at this index. - - + Gets the priority of this plugin for the recognized extension. Higher priority plugins will be preferred. The default priority is [code]1.0[/code]. - - + Gets the list of file extensions to associate with this loader (case-insensitive). e.g. [code]["obj"][/code]. - - + Gets the Godot resource type associated with this loader. e.g. [code]"Mesh"[/code] or [code]"Animation"[/code]. - - + Gets the extension used to save this resource in the [code].import[/code] directory. - - + Gets the name to display in the import window. You should choose this name as a continuation to "Import as", e.g. "Import as Special Mesh". - - - - - - - - - - - - + + + + + + Imports [code]source_file[/code] into [code]save_path[/code] with the import [code]options[/code] specified. The [code]platform_variants[/code] and [code]gen_files[/code] arrays will be modified by this function. This method must be overridden to do the actual importing work. See this class' description for an example of overriding this method. diff --git a/doc/classes/EditorInspector.xml b/doc/classes/EditorInspector.xml index e81b2b4a1b9..ea1c2590719 100644 --- a/doc/classes/EditorInspector.xml +++ b/doc/classes/EditorInspector.xml @@ -11,8 +11,7 @@ - - + Refreshes the inspector. [b]Note:[/b] To save on CPU resources, calling this method will do nothing if the time specified in [code]docks/property_editor/auto_refresh_interval[/code] editor setting hasn't passed yet since this method was last called. (By default, this interval is set to 0.3 seconds.) @@ -24,48 +23,40 @@ - - + Emitted when the Edit button of an [Object] has been pressed in the inspector. This is mainly used in the remote scene tree inspector. - - + Emitted when a property is edited in the inspector. - - + Emitted when a property is keyed in the inspector. Properties can be keyed by clicking the "key" icon next to a property when the Animation panel is toggled. - - + Emitted when a property is selected in the inspector. - - - - + + Emitted when a boolean property is toggled in the inspector. [b]Note:[/b] This signal is never emitted if the internal [code]autoclear[/code] property enabled. Since this property is always enabled in the editor inspector, this signal is never emitted by the editor itself. - - - - + + Emitted when a resource is selected in the inspector. diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index 07b3493ee8d..e2898c873df 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -16,89 +16,65 @@ - - - - + + Adds a custom control, not necessarily a property editor. - - - - - - + + + Adds a property editor, this must inherit [EditorProperty]. - - - - - - - - + + + + Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty]. - - - - + + Returns [code]true[/code] if this object can be handled by this plugin. - - - - + + Called to allow adding controls at the beginning of the list. - - - - - - + + + Called to allow adding controls at the beginning of the category. - - + Called to allow adding controls at the end of the list. - - - - - - - - - - - - - - + + + + + + + Called to allow adding property specific editors to the inspector. Usually these inherit [EditorProperty]. Returning [code]true[/code] removes the built-in editor for this property, otherwise allows to insert a custom editor before the built-in one. diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index 1c8ca041db0..33563126af0 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -11,261 +11,212 @@ - - - - + + Edits the given [Node]. The node will be also selected if it's inside the scene tree. - - - - + + Edits the given [Resource]. - - + Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly. - - + Returns the current path being viewed in the [FileSystemDock]. - - + Returns the edited (current) scene's root [Node]. - - + Returns the actual scale of the editor UI ([code]1.0[/code] being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins. [b]Note:[/b] This value is set via the [code]interface/editor/display_scale[/code] and [code]interface/editor/custom_display_scale[/code] editor settings. Editor must be restarted for changes to be properly applied. - - + Returns the editor's [EditorSettings] instance. - - + Returns the main editor control. Use this as a parent for main screens. [b]Note:[/b] This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically. - - + Returns the editor's [FileSystemDock] instance. - - + Returns the editor's [EditorInspector] instance. - - + Returns an [Array] with the file paths of the currently opened scenes. - - + Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string. - - + Returns the editor's [EditorFileSystem] instance. - - + Returns the editor's [EditorResourcePreview] instance. - - + Returns the editor's [ScriptEditor] instance. - - + Returns the path of the directory currently selected in the [FileSystemDock]. If a file is selected, its base directory will be returned using [method String.get_base_dir] instead. - - + Returns the editor's [EditorSelection] instance. - - - - - - - - + + + + Shows the given property on the given [code]object[/code] in the editor's Inspector dock. If [code]inspector_only[/code] is [code]true[/code], plugins will not attempt to edit [code]object[/code]. - - + Returns [code]true[/code] if a scene is currently being played, [code]false[/code] otherwise. Paused scenes are considered as being played. - - - - + + Returns [code]true[/code] if the specified [code]plugin[/code] is enabled. The plugin name is the same as its directory name. - - - - - - + + + Returns mesh previews rendered at the given size as an [Array] of [Texture]s. - - - - + + Opens the scene at the given path. - - + Plays the currently active scene. - - - - + + Plays the scene specified by its filepath. - - + Plays the main scene. - - - - + + Reloads the scene at the given path. - - + Saves the scene. Returns either [code]OK[/code] or [code]ERR_CANT_CREATE[/code] (see [@GlobalScope] constants). - - - - - - + + + Saves the scene as a file at [code]path[/code]. - - - - + + Selects the file, with the path provided by [code]file[/code], in the FileSystem dock. - - - - + + Sets the editor's current main screen to the one specified in [code]name[/code]. [code]name[/code] must match the text of the tab in question exactly ([code]2D[/code], [code]3D[/code], [code]Script[/code], [code]AssetLib[/code]). - - - - - - + + + Sets the enabled status of a plugin. The plugin name is the same as its directory name. - - + Stops the scene that is currently playing. diff --git a/doc/classes/EditorNavigationMeshGenerator.xml b/doc/classes/EditorNavigationMeshGenerator.xml index 112c598c80a..d5f46da99fd 100644 --- a/doc/classes/EditorNavigationMeshGenerator.xml +++ b/doc/classes/EditorNavigationMeshGenerator.xml @@ -8,20 +8,15 @@ - - - - - - + + + - - - - + + diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index bf3b5c96f2a..bc61063c97a 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -11,34 +11,25 @@ - - - - - - + + + Adds a script at [code]path[/code] to the Autoload list as [code]name[/code]. - - - - - - + + + Adds a control to the bottom panel (together with Output, Debug, Animation, etc). Returns a reference to the button added. It's up to you to hide/show the button when needed. When your plugin is deactivated, make sure to remove your custom control with [method remove_control_from_bottom_panel] and free it with [method Node.queue_free]. - - - - - - + + + Adds a custom control to a container (see [enum CustomControlContainer]). There are many locations where custom controls can be added in the editor UI. Please remember that you have to manage the visibility of your custom controls yourself (and likely hide it after adding it). @@ -46,12 +37,9 @@ - - - - - - + + + Adds the control to a specific dock slot (see [enum DockSlot] for options). If the dock is repositioned and as long as the plugin is active, the editor will save the dock position on further sessions. @@ -59,16 +47,11 @@ - - - - - - - - - - + + + + + Adds a custom type, which will appear in the list of nodes or resources. An icon can be optionally passed. When given node or resource is selected, the base type will be instanced (ie, "Spatial", "Control", "Resource"), then the script will be loaded and set to this object. @@ -77,20 +60,16 @@ - - - - + + Registers a new [EditorExportPlugin]. Export plugins are used to perform tasks when the project is being exported. See [method add_inspector_plugin] for an example of how to register a plugin. - - - - + + Registers a new [EditorImportPlugin]. Import plugins are used to import custom and unsupported assets as a custom [Resource] type. [b]Note:[/b] If you want to import custom 3D asset formats use [method add_scene_import_plugin] instead. @@ -98,10 +77,8 @@ - - - - + + Registers a new [EditorInspectorPlugin]. Inspector plugins are used to extend [EditorInspector] and provide custom configuration tools for your object's properties. [b]Note:[/b] Always use [method remove_inspector_plugin] to remove the registered [EditorInspectorPlugin] when your [EditorPlugin] is disabled to prevent leaks and an unexpected behavior. @@ -118,101 +95,80 @@ - - - - + + Registers a new [EditorSceneImporter]. Scene importers are used to import custom 3D asset formats as scenes. - - - - + + Registers a new [EditorSpatialGizmoPlugin]. Gizmo plugins are used to add custom gizmos to the 3D preview viewport for a [Spatial]. See [method add_inspector_plugin] for an example of how to register a plugin. - - - - - - - - - - + + + + + Adds a custom menu item to [b]Project > Tools[/b] as [code]name[/code] that calls [code]callback[/code] on an instance of [code]handler[/code] with a parameter [code]ud[/code] when user activates it. - - - - - - + + + Adds a custom submenu under [b]Project > Tools >[/b] [code]name[/code]. [code]submenu[/code] should be an object of class [PopupMenu]. This submenu should be cleaned up using [code]remove_tool_menu_item(name)[/code]. - - + This method is called when the editor is about to save the project, switch to another tab, etc. It asks the plugin to apply any pending state changes to ensure consistency. This is used, for example, in shader editors to let the plugin know that it must apply the shader code being written by the user to the object. - - + This method is called when the editor is about to run the project. The plugin can then perform required operations before the project runs. This method must return a boolean. If this method returns [code]false[/code], the project will not run. The run is aborted immediately, so this also prevents all other plugins' [method build] methods from running. - - + Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. - - + Called by the engine when the user disables the [EditorPlugin] in the Plugin tab of the project settings window. - - - - + + This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. - - + Called by the engine when the user enables the [EditorPlugin] in the Plugin tab of the project settings window. - - - - + + Called by the engine when the 2D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. [codeblock] @@ -230,20 +186,16 @@ - - - - + + This method is the same as [method forward_canvas_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. - - - - + + Called when there is a root node in the current edited scene, [method handles] is implemented and an [InputEvent] happens in the 2D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: [codeblock] @@ -264,10 +216,8 @@ - - - - + + Called by the engine when the 3D editor's viewport is updated. Use the [code]overlay[/code] [Control] for drawing. You can update the viewport manually by calling [method update_overlays]. [codeblock] @@ -285,22 +235,17 @@ - - - - + + This method is the same as [method forward_spatial_draw_over_viewport], except it draws on top of everything. Useful when you need an extra layer that shows over anything else. You need to enable calling of this method by using [method set_force_draw_over_forwarding_enabled]. - - - - - - + + + Called when there is a root node in the current edited scene, [method handles] is implemented and an [InputEvent] happens in the 3D viewport. Intercepts the [InputEvent], if [code]return true[/code] [EditorPlugin] consumes the [code]event[/code], otherwise forwards [code]event[/code] to other Editor classes. Example: [codeblock] @@ -321,22 +266,19 @@ - - + This is for editors that edit script-based objects. You can return a list of breakpoints in the format ([code]script:line[/code]), for example: [code]res://path_to_script.gd:25[/code]. - - + Returns the [EditorInterface] object that gives you control over Godot editor's window and its functionalities. - - + Override this method in your plugin to return a [Texture] in order to give it an icon. For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. @@ -351,236 +293,190 @@ - - + Override this method in your plugin to provide the name of the plugin when displayed in the Godot editor. For main screen plugins, this appears at the top of the screen, to the right of the "2D", "3D", "Script", and "AssetLib" buttons. - - + Gets the Editor's dialogue used for making scripts. [b]Note:[/b] Users can configure it before use. - - + Gets the state of your plugin editor. This is used when saving the scene (so state is kept when opening it again) and for switching tabs (so state can be restored when the tab returns). - - + Gets the undo/redo object. Most actions in the editor can be undoable, so use this object to make sure this happens when it's worth it. - - - - + + Gets the GUI layout of the plugin. This is used to save the project's editor layout when [method queue_save_layout] is called or the editor layout was changed(For example changing the position of a dock). - - - - + + Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method edit] and [method make_visible] called when the editor requests them. If you have declared the methods [method forward_canvas_gui_input] and [method forward_spatial_gui_input] these will be called too. - - + Returns [code]true[/code] if this is a main screen editor plugin (it goes in the workspace selector together with [b]2D[/b], [b]3D[/b], [b]Script[/b] and [b]AssetLib[/b]). - - + Minimizes the bottom panel. - - - - + + Makes a specific item in the bottom panel visible. - - - - + + This function will be called when the editor is requested to become visible. It is used for plugins that edit a specific object type. Remember that you have to manage the visibility of all your editor controls manually. - - + Queue save the project's editor layout. - - - - + + Removes an Autoload [code]name[/code] from the list. - - - - + + Removes the control from the bottom panel. You have to manually [method Node.queue_free] the control. - - - - - - + + + Removes the control from the specified container. You have to manually [method Node.queue_free] the control. - - - - + + Removes the control from the dock. You have to manually [method Node.queue_free] the control. - - - - + + Removes a custom type added by [method add_custom_type]. - - - - + + Removes an export plugin registered by [method add_export_plugin]. - - - - + + Removes an import plugin registered by [method add_import_plugin]. - - - - + + Removes an inspector plugin registered by [method add_import_plugin] - - - - + + Removes a scene importer registered by [method add_scene_import_plugin]. - - - - + + Removes a gizmo plugin registered by [method add_spatial_gizmo_plugin]. - - - - + + Removes a menu [code]name[/code] from [b]Project > Tools[/b]. - - + 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. - - + Enables calling of [method forward_canvas_force_draw_over_viewport] for the 2D editor and [method forward_spatial_force_draw_over_viewport] for the 3D editor when their viewports are updated. You need to call this method only once and it will work permanently for this plugin. - - + Use this method if you always want to receive inputs from 3D view screen inside [method forward_spatial_gui_input]. It might be especially usable if your plugin will want to use raycast in the scene. - - - - + + Restore the state saved by [method get_state]. - - - - + + Restore the plugin GUI layout saved by [method get_window_layout]. - - + Updates the overlays of the 2D and 3D editor viewport. Causes methods [method forward_canvas_draw_over_viewport], [method forward_canvas_force_draw_over_viewport], [method forward_spatial_draw_over_viewport] and [method forward_spatial_force_draw_over_viewport] to be called. @@ -588,28 +484,24 @@ - - + Emitted when user changes the workspace ([b]2D[/b], [b]3D[/b], [b]Script[/b], [b]AssetLib[/b]). Also works with custom screens defined by plugins. - - + - - + Emitted when the scene is changed in the editor. The argument will return the root node of the scene that has just become active. If this scene is new and empty, the argument will be [code]null[/code]. - - + Emitted when user closes a scene. The argument is file path to a closed scene. diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index fe5fdf5e708..53a31eb5271 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -10,62 +10,49 @@ - - - - + + If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. - - - - - - - - - - + + + + + If one or several properties have changed, this must be called. [code]field[/code] is used in case your editor can modify fields separately (as an example, Vector3.x). The [code]changing[/code] argument avoids the editor requesting this property to be refreshed (leave as [code]false[/code] if unsure). - - + Gets the edited object. - - + Gets the edited property. If your editor is for a single property (added via [method EditorInspectorPlugin.parse_property]), then this will return the property. - - + Override if you want to allow a custom tooltip over your property. - - - - + + Adds controls with this function if you want them on the bottom (below the label). - - + When this virtual function is called, you must update your editor. @@ -93,71 +80,56 @@ - - - - + + Emit it if you want multiple properties modified at the same time. Do not use if added via [method EditorInspectorPlugin.parse_property]. - - - - + + Used by sub-inspectors. Emit it if what was selected was an Object ID. - - - - + + Do not emit this manually, use the [method emit_changed] method instead. - - - - + + Emitted when a property was checked. Used internally. - - + Emit it if you want to add this value as an animation key (check for keying being enabled first). - - - - + + Emit it if you want to key a property with a single value. - - - - + + If you want a sub-resource to be edited, emit this signal with the resource. - - - - + + Emitted when selected. Used internally. diff --git a/doc/classes/EditorResourceConversionPlugin.xml b/doc/classes/EditorResourceConversionPlugin.xml index 2fca3e803fe..fc7dda74ffe 100644 --- a/doc/classes/EditorResourceConversionPlugin.xml +++ b/doc/classes/EditorResourceConversionPlugin.xml @@ -8,16 +8,13 @@ - - - - + + - - + diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index 9072a7ee4b4..38083b439fc 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -11,60 +11,44 @@ - - - - + + Create an own, custom preview generator. - - - - + + Check if the resource changed, if so, it will be invalidated and the corresponding signal emitted. - - - - - - - - - - + + + + + Queue the [code]resource[/code] being edited for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture] preview, [Texture] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. [b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. - - - - - - - - - - + + + + + Queue a resource file located at [code]path[/code] for preview. Once the preview is ready, the [code]receiver[/code]'s [code]receiver_func[/code] will be called. The [code]receiver_func[/code] must take the following four arguments: [String] path, [Texture] preview, [Texture] thumbnail_preview, [Variant] userdata. [code]userdata[/code] can be anything, and will be returned when [code]receiver_func[/code] is called. [b]Note[/b]: If it was not possible to create the preview the [code]receiver_func[/code] will still be called, but the preview will be null. - - - - + + Removes a custom preview generator. @@ -72,8 +56,7 @@ - - + Emitted if a preview was invalidated (changed). [code]path[/code] corresponds to the path of the preview. diff --git a/doc/classes/EditorResourcePreviewGenerator.xml b/doc/classes/EditorResourcePreviewGenerator.xml index fb7e333d7b7..fa15b45409f 100644 --- a/doc/classes/EditorResourcePreviewGenerator.xml +++ b/doc/classes/EditorResourcePreviewGenerator.xml @@ -10,20 +10,16 @@ - - + If this function returns [code]true[/code], the generator will call [method generate] or [method generate_from_path] for small previews as well. By default, it returns [code]false[/code]. - - - - - - + + + Generate a preview from a given resource with the specified size. This must always be implemented. Returning an empty texture is an OK way to fail and let another generator take care. @@ -31,12 +27,9 @@ - - - - - - + + + Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method generate]. Returning an empty texture is an OK way to fail and let another generator take care. @@ -44,18 +37,15 @@ - - + If this function returns [code]true[/code], the generator will automatically generate the small previews from the normal preview texture generated by the methods [method generate] or [method generate_from_path]. By default, it returns [code]false[/code]. - - - - + + Returns [code]true[/code] if your generator supports the resource of type [code]type[/code]. diff --git a/doc/classes/EditorSceneImporter.xml b/doc/classes/EditorSceneImporter.xml index 6a2c42bf44a..56cee5458df 100644 --- a/doc/classes/EditorSceneImporter.xml +++ b/doc/classes/EditorSceneImporter.xml @@ -9,62 +9,44 @@ - - + - - + - - - - - - - - + + + + - - - - - - - - + + + + - - - - - - - - + + + + - - - - - - - - + + + + diff --git a/doc/classes/EditorScenePostImport.xml b/doc/classes/EditorScenePostImport.xml index f58b03d9a41..9ae2d510818 100644 --- a/doc/classes/EditorScenePostImport.xml +++ b/doc/classes/EditorScenePostImport.xml @@ -30,24 +30,20 @@ - - + Returns the source file path which got imported (e.g. [code]res://scene.dae[/code]). - - + Returns the resource folder the imported scene file is located in. - - - - + + Called after the scene was imported. This method must return the modified version of the scene. diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 5fd756d9000..91be0507964 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -20,32 +20,27 @@ - - + This method is executed by the Editor when [b]File > Run[/b] is used. - - - - + + Adds [code]node[/code] as a child of the root node in the editor context. [b]Warning:[/b] The implementation of this method is currently disabled. - - + Returns the [EditorInterface] singleton instance. - - + Returns the Editor's currently active scene. diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index 48a146034ca..cd2ad32d294 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -11,41 +11,34 @@ - - - - + + Adds a node to the selection. [b]Note:[/b] The newly selected node will not be automatically edited in the inspector. If you want to edit a node, use [method EditorInterface.edit_node]. - - + Clear the selection. - - + Gets the list of selected nodes. - - + Gets the list of selected nodes, optimized for transform operations (i.e. moving them, rotating, etc). This list avoids situations where a node is selected and also child/grandchild. - - - - + + Removes a node from the selection. diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 3c03ea99499..26a2dd499a6 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -22,10 +22,8 @@ - - - - + + Adds a custom property info to a property. The dictionary must contain: - [code]name[/code]: [String] (the name of the property) @@ -47,60 +45,48 @@ - - - - + + Erases the setting whose name is specified by [code]property[/code]. - - + Returns the list of favorite files and directories for this project. - - - - - - - - + + + + Returns project-specific metadata for the [code]section[/code] and [code]key[/code] specified. If the metadata doesn't exist, [code]default[/code] will be returned instead. See also [method set_project_metadata]. - - + Returns the project-specific settings path. Projects all have a unique subdirectory inside the settings path where project-specific settings are saved. - - + Returns the list of recently visited folders in the file dialog for this project. - - - - + + Returns the value of the setting specified by [code]name[/code]. This is equivalent to using [method Object.get] on the EditorSettings instance. - - + Gets the global settings path for the engine. Inside this path, you can find some standard paths such as: [code]settings/tmp[/code] - Used for temporary storage of files @@ -108,83 +94,62 @@ - - - - + + Returns [code]true[/code] if the setting specified by [code]name[/code] exists, [code]false[/code] otherwise. - - - - + + Returns [code]true[/code] if the setting specified by [code]name[/code] can have its value reverted to the default value, [code]false[/code] otherwise. When this method returns [code]true[/code], a Revert button will display next to the setting in the Editor Settings. - - - - + + Returns the default value of the setting specified by [code]name[/code]. This is the value that would be applied when clicking the Revert button in the Editor Settings. - - - - + + Sets the list of favorite files and directories for this project. - - - - - - - - + + + + Sets the initial value of the setting specified by [code]name[/code] to [code]value[/code]. This is used to provide a value for the Revert button in the Editor Settings. If [code]update_current[/code] is true, the current value of the setting will be set to [code]value[/code] as well. - - - - - - - - + + + + Sets project-specific metadata with the [code]section[/code], [code]key[/code] and [code]data[/code] specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also [method get_project_metadata]. - - - - + + Sets the list of recently visited folders in the file dialog for this project. - - - - - - + + + Sets the [code]value[/code] of the setting specified by [code]name[/code]. This is equivalent to using [method Object.set] on the EditorSettings instance. diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index a41821ce463..dcf569c65d3 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -10,180 +10,135 @@ - - - - + + Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this function during [method redraw]. - - - - + + Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw]. - - - - - - - - - - + + + + + Adds a list of handles (points) which can be used to deform the object being edited. There are virtual functions which will be called upon editing of these handles. Call this function during [method redraw]. - - - - - - - - - - + + + + + Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw]. - - - - - - - - - - + + + + + Adds a mesh to the gizmo with the specified [code]billboard[/code] state, [code]skeleton[/code] and [code]material[/code]. If [code]billboard[/code] is [code]true[/code], the mesh will rotate to always face the camera. Call this function during [method redraw]. - - - - - - - - + + + + Adds an unscaled billboard for visualization. Call this function during [method redraw]. - - + Removes everything in the gizmo including meshes, collisions and handles. - - - - - - - - + + + + Commit a handle being edited (handles must have been previously added by [method add_handles]). If the [code]cancel[/code] parameter is [code]true[/code], an option to restore the edited value to the original is provided. - - - - + + Gets the name of an edited handle (handles must have been previously added by [method add_handles]). Handles can be named for reference to the user when editing. - - - - + + Gets actual value of a handle. This value can be anything and used for eventually undoing the motion when calling [method commit_handle]. - - + Returns the [EditorSpatialGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorSpatialGizmoPlugin.get_material]. - - + Returns the Spatial node associated with this gizmo. - - - - + + Returns [code]true[/code] if the handle at index [code]index[/code] is highlighted by being hovered with the mouse. - - + This function is called when the [Spatial] this gizmo refers to changes (the [method Spatial.update_gizmo] is called). - - - - - - - - + + + + This function is used when the user drags a gizmo handle (previously added with [method add_handles]) in screen coordinates. The [Camera] is also provided so screen coordinates can be converted to raycasts. - - - - + + Sets the gizmo's hidden state. If [code]true[/code], the gizmo will be hidden. If [code]false[/code], it will be shown. - - - - + + Sets the reference [Spatial] node for the gizmo. [code]node[/code] must inherit from [Spatial]. diff --git a/doc/classes/EditorSpatialGizmoPlugin.xml b/doc/classes/EditorSpatialGizmoPlugin.xml index cd43fec4a9b..4f1e7c3013a 100644 --- a/doc/classes/EditorSpatialGizmoPlugin.xml +++ b/doc/classes/EditorSpatialGizmoPlugin.xml @@ -11,185 +11,136 @@ - - - - - - + + + Adds a new material to the internal material list for the plugin. It can then be accessed with [method get_material]. Should not be overridden. - - + Override this method to define whether the gizmo can be hidden or not. Returns [code]true[/code] if not overridden. - - - - - - - - - - + + + + + Override this method to commit gizmo handles. Called for this plugin's active gizmos. - - - - + + Override this method to return a custom [EditorSpatialGizmo] for the spatial nodes of your choice, return [code]null[/code] for the rest of nodes. See also [method has_gizmo]. - - - - - - + + + Creates a handle material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorSpatialGizmo.add_handles]. Should not be overridden. - - - - - - - - - - + + + + + Creates an icon material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorSpatialGizmo.add_unscaled_billboard]. Should not be overridden. - - - - - - - - - - - - + + + + + + Creates an unshaded material with its variants (selected and/or editable) and adds them to the internal material list. They can then be accessed with [method get_material] and used in [method EditorSpatialGizmo.add_mesh] and [method EditorSpatialGizmo.add_lines]. Should not be overridden. - - - - - - + + + Override this method to provide gizmo's handle names. Called for this plugin's active gizmos. - - - - - - + + + Gets actual value of a handle from gizmo. Called for this plugin's active gizmos. - - - - - - + + + Gets material from the internal list of materials. If an [EditorSpatialGizmo] is provided, it will try to get the corresponding variant (selected and/or editable). - - + Override this method to provide the name that will appear in the gizmo visibility menu. - - + Override this method to set the gizmo's priority. Higher values correspond to higher priority. If a gizmo with higher priority conflicts with another gizmo, only the gizmo with higher priority will be used. All built-in editor gizmos return a priority of [code]-1[/code]. If not overridden, this method will return [code]0[/code], which means custom gizmos will automatically override built-in gizmos. - - - - + + Override this method to define which Spatial nodes have a gizmo from this plugin. Whenever a [Spatial] node is added to a scene this method is called, if it returns [code]true[/code] the node gets a generic [EditorSpatialGizmo] assigned and is added to this plugin's list of active gizmos. - - - - - - + + + Gets whether a handle is highlighted or not. Called for this plugin's active gizmos. - - + Override this method to define whether a Spatial with this gizmo should be selectable even when the gizmo is hidden. - - - - + + Callback to redraw the provided gizmo. Called for this plugin's active gizmos. - - - - - - - - - - + + + + + Update the value of a handle after it has been updated. Called for this plugin's active gizmos. diff --git a/doc/classes/EditorVCSInterface.xml b/doc/classes/EditorVCSInterface.xml index 2125e8fdb4d..deea48ae645 100644 --- a/doc/classes/EditorVCSInterface.xml +++ b/doc/classes/EditorVCSInterface.xml @@ -10,19 +10,15 @@ - - - - + + Creates a version commit if the addon is initialized, else returns without doing anything. Uses the files which have been staged previously, with the commit message set to a value as provided as in the argument. - - - - + + Returns an [Array] of [Dictionary] objects containing the diff output from the VCS in use, if a VCS addon is initialized, else returns an empty [Array] object. The diff contents also consist of some contextual lines which provide context to the observed line change in the file. Each [Dictionary] object has the line diff contents under the keys: @@ -35,8 +31,7 @@ - - + Returns a [Dictionary] containing the path of the detected file change mapped to an integer signifying what kind of change the corresponding file has experienced. The following integer values are being used to signify that the detected file is: @@ -48,63 +43,52 @@ - - + Returns the project name of the VCS working directory. - - + Returns the name of the VCS if the VCS has been initialized, else return an empty string. - - - - + + Initializes the VCS addon if not already. Uses the argument value as the path to the working directory of the project. Creates the initial commit if required. Returns [code]true[/code] if no failure occurs, else returns [code]false[/code]. - - + Returns [code]true[/code] if the addon is ready to respond to function calls, else returns [code]false[/code]. - - + Returns [code]true[/code] if the VCS addon has been initialized, else returns [code]false[/code]. - - + Shuts down the VCS addon to allow cleanup code to run on call. Returns [code]true[/code] is no failure occurs, else returns [code]false[/code]. - - - - + + Stages the file which should be committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path. - - - - + + Unstages the file which was staged previously to be committed, so that it is no longer committed when [method EditorVCSInterface.commit] is called. Argument should contain the absolute path. diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index d82b57416b2..cc19fc39beb 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -10,8 +10,7 @@ - - + Returns engine author information in a Dictionary. [code]lead_developers[/code] - Array of Strings, lead developer names @@ -21,8 +20,7 @@ - - + Returns an Array of copyright information Dictionaries. [code]name[/code] - String, component name @@ -30,81 +28,69 @@ - - + Returns a Dictionary of Arrays of donor names. {[code]platinum_sponsors[/code], [code]gold_sponsors[/code], [code]silver_sponsors[/code], [code]bronze_sponsors[/code], [code]mini_sponsors[/code], [code]gold_donors[/code], [code]silver_donors[/code], [code]bronze_donors[/code]} - - + Returns the total number of frames drawn. If the render loop is disabled with [code]--disable-render-loop[/code] via command line, this returns [code]0[/code]. See also [method get_idle_frames]. - - + Returns the frames per second of the running game. - - + Returns the total number of frames passed since engine initialization which is advanced on each [b]idle frame[/b], regardless of whether the render loop is enabled. See also [method get_frames_drawn]. - - + Returns Dictionary of licenses used by Godot and included third party components. - - + Returns Godot license text. - - + Returns the main loop object (see [MainLoop] and [SceneTree]). - - + Returns the total number of frames passed since engine initialization which is advanced on each [b]physics frame[/b]. - - + Returns the fraction through the current physics tick we are at the time of rendering the frame. This can be used to implement fixed timestep interpolation. - - - - + + Returns a global singleton with given [code]name[/code]. Often used for plugins, e.g. [code]GodotPayment[/code] on Android. - - + Returns the current engine version information in a Dictionary. [code]major[/code] - Holds the major version number as an int @@ -126,17 +112,14 @@ - - - - + + Returns [code]true[/code] if a singleton with given [code]name[/code] exists in global scope. - - + Returns [code]true[/code] if the game is inside the fixed process and physics phase of the game loop. diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index ea1db1cab1d..8ebed02c64d 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -20,21 +20,16 @@ - - - - + + Returns [code]true[/code] if the glow level [code]idx[/code] is specified, [code]false[/code] otherwise. - - - - - - + + + Enables or disables the glow level at index [code]idx[/code]. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled. diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml index ffd57a3db41..565c76cc1f3 100644 --- a/doc/classes/Expression.xml +++ b/doc/classes/Expression.xml @@ -27,40 +27,31 @@ - - - - - - - - + + + + Executes the expression that was previously parsed by [method parse] and returns the result. Before you use the returned object, you should check if the method failed by calling [method has_execute_failed]. If you defined input variables in [method parse], you can specify their values in the inputs array, in the same order. - - + Returns the error text if [method parse] has failed. - - + Returns [code]true[/code] if [method execute] has failed. - - - - - - + + + Parses the expression and returns an [enum Error] code. You can optionally specify names of variables that may appear in the expression with [code]input_names[/code], so that you can bind them when it gets executed. diff --git a/doc/classes/ExternalTexture.xml b/doc/classes/ExternalTexture.xml index 85937506182..bb92bcc4f57 100644 --- a/doc/classes/ExternalTexture.xml +++ b/doc/classes/ExternalTexture.xml @@ -11,8 +11,7 @@ - - + Returns the external texture name. diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 0a16471ffc4..0e6f10bd1ff 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -30,285 +30,231 @@ - - + Closes the currently opened file and prevents subsequent read/write operations. Use [method flush] to persist the data to disk without closing the file. - - + Returns [code]true[/code] if the file cursor has read past the end of the file. [b]Note:[/b] This function will still return [code]false[/code] while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low-level file access works in all operating systems. There is always [method get_len] and [method get_position] to implement a custom logic. - - - - + + Returns [code]true[/code] if the file exists in the given path. [b]Note:[/b] Many resources types are imported (e.g. textures or sound files), and their source asset will not be included in the exported game, as only the imported version is used. See [method ResourceLoader.exists] for an alternative approach that takes resource remapping into account. - - + Writes the file's buffer to disk. Flushing is automatically performed when the file is closed. This means you don't need to call [method flush] manually before closing a file using [method close]. Still, calling [method flush] can be used to ensure the data is safe even if the project crashes instead of being closed gracefully. [b]Note:[/b] Only call [method flush] when you actually need it. Otherwise, it will decrease performance due to constant disk writes. - - + Returns the next 16 bits from the file as an integer. See [method store_16] for details on what values can be stored and retrieved this way. - - + Returns the next 32 bits from the file as an integer. See [method store_32] for details on what values can be stored and retrieved this way. - - + Returns the next 64 bits from the file as an integer. See [method store_64] for details on what values can be stored and retrieved this way. - - + Returns the next 8 bits from the file as an integer. See [method store_8] for details on what values can be stored and retrieved this way. - - + Returns the whole file as a [String]. Text is interpreted as being UTF-8 encoded. - - - - + + Returns next [code]len[/code] bytes of the file as a [PoolByteArray]. - - - - + + Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. Text is interpreted as being UTF-8 encoded. - - + Returns the next 64 bits from the file as a floating-point number. - - + Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [enum Error]. - - + Returns the next 32 bits from the file as a floating-point number. - - + Returns the size of the file in bytes. - - + Returns the next line of the file as a [String]. Text is interpreted as being UTF-8 encoded. - - - - + + Returns an MD5 String representing the file at the given path or an empty [String] on failure. - - - - + + Returns the last time the [code]file[/code] was modified in unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time]. - - + Returns a [String] saved in Pascal format from the file. Text is interpreted as being UTF-8 encoded. - - + Returns the path as a [String] for the current open file. - - + Returns the absolute path as a [String] for the current open file. - - + Returns the file cursor's position. - - + Returns the next bits from the file as a floating-point number. - - - - + + Returns a SHA-256 [String] representing the file at the given path or an empty [String] on failure. - - - - + + Returns the next [Variant] value from the file. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. - - + Returns [code]true[/code] if the file is currently opened. - - - - - - + + + Opens the file for writing or reading, depending on the flags. - - - - - - - - + + + + Opens a compressed file for reading or writing. [b]Note:[/b] [method open_compressed] can only read files that were saved by Godot, not third-party compression formats. See [url=https://github.com/godotengine/godot/issues/28999]GitHub issue #28999[/url] for a workaround. - - - - - - - - + + + + Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. [b]Note:[/b] The provided key must be 32 bytes long. - - - - - - - - + + + + Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. - - - - + + Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file). - - - - + + Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). [b]Note:[/b] This is an offset, so you should use negative numbers or the cursor will be at the end of the file. - - - - + + Stores an integer as 16 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^16 - 1][/code]. Any other value will overflow and wrap around. @@ -334,10 +280,8 @@ - - - - + + Stores an integer as 32 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^32 - 1][/code]. Any other value will overflow and wrap around. @@ -345,20 +289,16 @@ - - - - + + Stores an integer as 64 bits in the file. [b]Note:[/b] The [code]value[/code] must lie in the interval [code][-2^63, 2^63 - 1][/code] (i.e. be a valid [int] value). - - - - + + Stores an integer as 8 bits in the file. [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 255][/code]. Any other value will overflow and wrap around. @@ -366,88 +306,68 @@ - - - - + + Stores the given array of bytes in the file. - - - - - - + + + Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. Text will be encoded as UTF-8. - - - - + + Stores a floating-point number as 64 bits in the file. - - - - + + Stores a floating-point number as 32 bits in the file. - - - - + + Appends [code]line[/code] to the file followed by a line return character ([code]\n[/code]), encoding the text as UTF-8. - - - - + + Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). Text will be encoded as UTF-8. - - - - + + Stores a floating-point number in the file. - - - - + + Appends [code]string[/code] to the file without a line return, encoding the text as UTF-8. - - - - - - + + + Stores any Variant value in the file. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). [b]Note:[/b] Not all properties are included. Only properties that are configured with the [constant PROPERTY_USAGE_STORAGE] flag set will be serialized. You can add a new usage flag to a property by overriding the [method Object._get_property_list] method in your class. You can also check how property usage is configured by calling [method Object._get_property_list]. See [enum PropertyUsageFlags] for the possible usage flags. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index e503301df88..1ed3e685496 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -10,45 +10,38 @@ - - - - + + Adds [code]filter[/code] as a custom filter; [code]filter[/code] should be of the form [code]"filename.extension ; Description"[/code]. For example, [code]"*.png ; PNG Images"[/code]. - - + Clear all the added filters in the dialog. - - + Clear currently selected items in the dialog. - - + Returns the LineEdit for the selected file. - - + Returns the vertical box container of the dialog, custom controls can be added to it. - - + Invalidate and update the current dialog content list. @@ -85,22 +78,19 @@ - - + Emitted when the user selects a directory. - - + Emitted when the user selects a file by double-clicking it or pressing the [b]OK[/b] button. - - + Emitted when the user selects multiple files. diff --git a/doc/classes/FileSystemDock.xml b/doc/classes/FileSystemDock.xml index a653e31506d..d27b4c1c192 100644 --- a/doc/classes/FileSystemDock.xml +++ b/doc/classes/FileSystemDock.xml @@ -8,44 +8,31 @@ - - - - - - - - + + + + - - - - - - - - + + + + - - - - - - + + + - - - - + + @@ -56,42 +43,34 @@ - - + - - - - + + - - - - + + - - + - - + - - + diff --git a/doc/classes/Font.xml b/doc/classes/Font.xml index 91b0844e0a8..d43aab8d2f2 100644 --- a/doc/classes/Font.xml +++ b/doc/classes/Font.xml @@ -12,112 +12,84 @@ - - - - - - - - - - - - - - + + + + + + + Draw [code]string[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. See also [method CanvasItem.draw_string]. - - - - - - - - - - - - - - + + + + + + + Draw character [code]char[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally kerning if [code]next[/code] is passed. clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. - - + Returns the font ascent (number of pixels above the baseline). - - - - - - + + + Returns the size of a character, optionally taking kerning into account if the next character is provided. Note that the height returned is the font height (see [method get_height]) and has no relation to the glyph height. - - + Returns the font descent (number of pixels below the baseline). - - + Returns the total font height (ascent plus descent) in pixels. - - - - + + Returns the size of a string, taking kerning and advance into account. Note that the height returned is the font height (see [method get_height]) and has no relation to the string. - - - - - - + + + Returns the size that the string would have with word wrapping enabled with a fixed [code]width[/code]. - - + Returns [code]true[/code] if the font has an outline. - - + - - + After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it. diff --git a/doc/classes/FuncRef.xml b/doc/classes/FuncRef.xml index fe7b742c005..0e1e1479340 100644 --- a/doc/classes/FuncRef.xml +++ b/doc/classes/FuncRef.xml @@ -11,33 +11,27 @@ - - + Calls the referenced function previously set in [member function] or [method @GDScript.funcref]. - - - - + + Calls the referenced function previously set in [member function] or [method @GDScript.funcref]. Contrarily to [method call_func], this method does not support a variable number of arguments but expects all parameters to be passed via a single [Array]. - - + Returns whether the object still exists and has the function assigned. - - - - + + The object containing the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary]. diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml index 36fac40116b..2a1d736c335 100644 --- a/doc/classes/GIProbe.xml +++ b/doc/classes/GIProbe.xml @@ -15,19 +15,15 @@ - - - - - - + + + Bakes the effect from all [GeometryInstance]s marked with [member GeometryInstance.use_in_baked_light] and [Light]s marked with either [constant Light.BAKE_INDIRECT] or [constant Light.BAKE_ALL]. If [code]create_visual_debug[/code] is [code]true[/code], after baking the light, this will generate a [MultiMesh] that has a cube representing each solid cell with each cube colored to the cell's albedo color. This can be used to visualize the [GIProbe]'s data and debug any issues that may be occurring. - - + Calls [method bake] with [code]create_visual_debug[/code] enabled. diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index 4064dcba282..4ffcc6faa42 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -10,110 +10,80 @@ - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 6dc91436b65..d6f950e288f 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -10,294 +10,210 @@ - - - - + + Returns an array with 6 [Plane]s that describe the sides of a box centered at the origin. The box size is defined by [code]extents[/code], which represents one (positive) corner of the box (i.e. half its actual size). - - - - - - - - - - - - + + + + + + Returns an array of [Plane]s closely bounding a faceted capsule centered at the origin with radius [code]radius[/code] and height [code]height[/code]. The parameter [code]sides[/code] defines how many planes will be generated for the side part of the capsule, whereas [code]lats[/code] gives the number of latitudinal steps at the bottom and top of the capsule. The parameter [code]axis[/code] describes the axis along which the capsule is oriented (0 for X, 1 for Y, 2 for Z). - - - - - - - - - - + + + + + Returns an array of [Plane]s closely bounding a faceted cylinder centered at the origin with radius [code]radius[/code] and height [code]height[/code]. The parameter [code]sides[/code] defines how many planes will be generated for the round part of the cylinder. The parameter [code]axis[/code] describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). - - - - - - + + + Clips the polygon defined by the points in [code]points[/code] against the [code]plane[/code] and returns the points of the clipped polygon. - - - - - - + + + Clips [code]polygon_a[/code] against [code]polygon_b[/code] and returns an array of clipped polygons. This performs [constant OPERATION_DIFFERENCE] between polygons. Returns an empty array if [code]polygon_b[/code] completely overlaps [code]polygon_a[/code]. If [code]polygon_b[/code] is enclosed by [code]polygon_a[/code], returns an outer polygon (boundary) and inner polygon (hole) which could be distinguished by calling [method is_polygon_clockwise]. - - - - - - + + + Clips [code]polyline[/code] against [code]polygon[/code] and returns an array of clipped polylines. This performs [constant OPERATION_DIFFERENCE] between the polyline and the polygon. This operation can be thought of as cutting a line with a closed shape. - - - - + + Given an array of [Vector2]s, returns the convex hull as a list of points in counterclockwise order. The last point is the same as the first one. - - - - - - + + + Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons_2d]) and returns an array of excluded polygons. This performs [constant OPERATION_XOR] between polygons. In other words, returns all but common area between polygons. The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. - - - - - - - - + + + + Returns the 3D point on the 3D segment ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point will always be inside the specified segment. - - - - - - - - + + + + Returns the 2D point on the 2D segment ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point will always be inside the specified segment. - - - - - - - - + + + + Returns the 3D point on the 3D line defined by ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point can be inside the segment ([code]s1[/code], [code]s2[/code]) or outside of it, i.e. somewhere on the line extending from the segment. - - - - - - - - + + + + Returns the 2D point on the 2D line defined by ([code]s1[/code], [code]s2[/code]) that is closest to [code]point[/code]. The returned point can be inside the segment ([code]s1[/code], [code]s2[/code]) or outside of it, i.e. somewhere on the line extending from the segment. - - - - - - - - - - + + + + + Given the two 3D segments ([code]p1[/code], [code]p2[/code]) and ([code]q1[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PoolVector3Array] that contains this point on ([code]p1[/code], [code]p2[/code]) as well the accompanying point on ([code]q1[/code], [code]q2[/code]). - - - - - - - - - - + + + + + Given the two 2D segments ([code]p1[/code], [code]q1[/code]) and ([code]p2[/code], [code]q2[/code]), finds those two points on the two segments that are closest to each other. Returns a [PoolVector2Array] that contains this point on ([code]p1[/code], [code]q1[/code]) as well the accompanying point on ([code]p2[/code], [code]q2[/code]). - - - - + + Used internally by the engine. - - - - - - + + + Intersects [code]polygon_a[/code] with [code]polygon_b[/code] and returns an array of intersected polygons. This performs [constant OPERATION_INTERSECTION] between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs. The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise]. - - - - - - + + + Intersects [code]polyline[/code] with [code]polygon[/code] and returns an array of intersected polylines. This performs [constant OPERATION_INTERSECTION] between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. - - - - - - - - + + + + Returns [code]true[/code] if [code]point[/code] is inside the circle or if it's located exactly [i]on[/i] the circle's boundary, otherwise returns [code]false[/code]. - - - - - - + + + Returns [code]true[/code] if [code]point[/code] is inside [code]polygon[/code] or if it's located exactly [i]on[/i] polygon's boundary, otherwise returns [code]false[/code]. - - - - + + Returns [code]true[/code] if [code]polygon[/code]'s vertices are ordered in clockwise order, otherwise returns [code]false[/code]. - - - - - - - - - - + + + + + Checks if the two lines ([code]from_a[/code], [code]dir_a[/code]) and ([code]from_b[/code], [code]dir_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns an empty [Variant]. [b]Note:[/b] The lines are specified using direction vectors, not end points. - - - - + + Given an array of [Vector2]s representing tiles, builds an atlas. The returned dictionary has two keys: [code]points[/code] is a vector of [Vector2] that specifies the positions of each tile, [code]size[/code] contains the overall size of the whole atlas as [Vector2]. - - - - - - + + + Merges (combines) [code]polygon_a[/code] and [code]polygon_b[/code] and returns an array of merged polygons. This performs [constant OPERATION_UNION] between polygons. The operation may result in an outer polygon (boundary) and multiple inner polygons (holes) produced which could be distinguished by calling [method is_polygon_clockwise]. - - - - - - - - + + + + Inflates or deflates [code]polygon[/code] by [code]delta[/code] units (pixels). If [code]delta[/code] is positive, makes the polygon grow outward. If [code]delta[/code] is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if [code]delta[/code] is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon. Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType]. @@ -312,16 +228,11 @@ - - - - - - - - - - + + + + + Inflates or deflates [code]polyline[/code] by [code]delta[/code] units (pixels), producing polygons. If [code]delta[/code] is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If [code]delta[/code] is negative, returns an empty array. Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType]. @@ -330,141 +241,96 @@ - - - - - - - - - - + + + + + Returns if [code]point[/code] is inside the triangle specified by [code]a[/code], [code]b[/code] and [code]c[/code]. - - - - - - - - - - - - + + + + + + Tests if the 3D ray starting at [code]from[/code] with the direction of [code]dir[/code] intersects the triangle specified by [code]a[/code], [code]b[/code] and [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, an empty [Variant] is returned. - - - - - - - - - - + + + + + Given the 2D segment ([code]segment_from[/code], [code]segment_to[/code]), returns the position on the segment (as a number between 0 and 1) at which the segment hits the circle that is located at position [code]circle_position[/code] and has radius [code]circle_radius[/code]. If the segment does not intersect the circle, -1 is returned (this is also the case if the line extending the segment would intersect the circle, but the segment does not). - - - - - - - - + + + + Given a convex hull defined though the [Plane]s in the array [code]planes[/code], tests if the segment ([code]from[/code], [code]to[/code]) intersects with that hull. If an intersection is found, returns a [PoolVector3Array] containing the point the intersection and the hull's normal. If no intersecion is found, an the returned array is empty. - - - - - - - - - - + + + + + Checks if the segment ([code]from[/code], [code]to[/code]) intersects the cylinder with height [code]height[/code] that is centered at the origin and has radius [code]radius[/code]. If no, returns an empty [PoolVector3Array]. If an intersection takes place, the returned array contains the point of intersection and the cylinder's normal at the point of intersection. - - - - - - - - - - + + + + + Checks if the two segments ([code]from_a[/code], [code]to_a[/code]) and ([code]from_b[/code], [code]to_b[/code]) intersect. If yes, return the point of intersection as [Vector2]. If no intersection takes place, returns an empty [Variant]. - - - - - - - - - - + + + + + Checks if the segment ([code]from[/code], [code]to[/code]) intersects the sphere that is located at [code]sphere_position[/code] and has radius [code]sphere_radius[/code]. If no, returns an empty [PoolVector3Array]. If yes, returns a [PoolVector3Array] containing the point of intersection and the sphere's normal at the point of intersection. - - - - - - - - - - - - + + + + + + Tests if the segment ([code]from[/code], [code]to[/code]) intersects the triangle [code]a[/code], [code]b[/code], [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, an empty [Variant] is returned. - - - - + + Triangulates the area specified by discrete set of [code]points[/code] such that no point is inside the circumcircle of any resulting triangle. Returns a [PoolIntArray] where each triangle consists of three consecutive point indices into [code]points[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PoolIntArray] is returned. - - - - + + Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PoolIntArray] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PoolIntArray] is returned. diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index f1fbe6bf995..c1dc4bf1f45 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -10,30 +10,23 @@ - - - - + + Returns the [enum GeometryInstance.Flags] that have been set for this object. - - - - + + Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero. - - - - - - + + + Sets the [enum GeometryInstance.Flags] specified. See [enum GeometryInstance.Flags] for options. diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index 87373ac3b74..93092343953 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -10,77 +10,59 @@ - - - - - - + + + Adds the specified color to the end of the ramp, with the specified offset. - - - - + + Returns the color of the ramp color at index [code]point[/code]. - - - - + + Returns the offset of the ramp color at index [code]point[/code]. - - + Returns the number of colors in the ramp. - - - - + + Returns the interpolated color specified by [code]offset[/code]. - - - - + + Removes the color at the index [code]point[/code]. - - - - - - + + + Sets the color of the ramp color at index [code]point[/code]. - - - - - - + + + Sets the offset for the ramp color at index [code]point[/code]. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index 193469585f4..dbc1cc1ff0c 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -11,163 +11,120 @@ - - - - - - + + + Makes possible the connection between two different slot types. The type is defined with the [method GraphNode.set_slot] method. - - - - + + Makes possible to disconnect nodes when dragging from the slot at the left if it has the specified type. - - - - + + Makes possible to disconnect nodes when dragging from the slot at the right if it has the specified type. - - + Removes all connections between nodes. - - - - - - - - - - + + + + + Create a connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection already exists, no connection is created. - - - - - - - - - - + + + + + Removes the connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection does not exist, no connection is removed. - - + Returns an Array containing the list of connections. A connection consists in a structure of the form [code]{ from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" }[/code]. - - + Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. Warning: The intended usage of this function is to allow you to reposition or add your own custom controls to the container. This is an internal control and as such should not be freed. If you wish to hide this or any of its children, use their [member CanvasItem.visible] property instead. - - - - - - - - - - + + + + + Returns [code]true[/code] if the [code]from_port[/code] slot of the [code]from[/code] GraphNode is connected to the [code]to_port[/code] slot of the [code]to[/code] GraphNode. - - - - - - + + + Returns whether it's possible to connect slots of the specified types. - - - - - - + + + Makes it not possible to connect between two different slot types. The type is defined with the [method GraphNode.set_slot] method. - - - - + + Removes the possibility to disconnect nodes when dragging from the slot at the left if it has the specified type. - - - - + + Removes the possibility to disconnect nodes when dragging from the slot at the right if it has the specified type. - - - - - - - - - - - - + + + + + + Sets the coloration of the connection between [code]from[/code]'s [code]from_port[/code] and [code]to[/code]'s [code]to_port[/code] with the color provided in the [code]activity[/code] theme property. - - - - + + Sets the specified [code]node[/code] as the one selected. @@ -213,36 +170,26 @@ - - - - - - + + + Emitted when user dragging connection from input port into empty space of the graph. - - - - - - - - + + + + Emitted to the GraphEdit when the connection between the [code]from_slot[/code] slot of the [code]from[/code] GraphNode and the [code]to_slot[/code] slot of the [code]to[/code] GraphNode is attempted to be created. - - - - - - + + + Emitted when user dragging connection from output port into empty space of the graph. @@ -258,14 +205,10 @@ - - - - - - - - + + + + Emitted to the GraphEdit when the connection between [code]from_slot[/code] slot of [code]from[/code] GraphNode and [code]to_slot[/code] slot of [code]to[/code] GraphNode is attempted to be removed. @@ -276,15 +219,13 @@ - - + Emitted when a GraphNode is selected. - - + @@ -294,15 +235,13 @@ - - + Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. [code]position[/code] is the position of the mouse pointer when the signal is sent. - - + Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code. diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index da0e79c8a53..1397d93be14 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -12,164 +12,125 @@ - - + Disables all input and output slots of the GraphNode. - - - - + + Disables input and output slot whose index is [code]idx[/code]. - - - - + + Returns the color of the input connection [code]idx[/code]. - - + Returns the number of enabled input slots (connections) to the GraphNode. - - - - + + Returns the position of the input connection [code]idx[/code]. - - - - + + Returns the type of the input connection [code]idx[/code]. - - - - + + Returns the color of the output connection [code]idx[/code]. - - + Returns the number of enabled output slots (connections) of the GraphNode. - - - - + + Returns the position of the output connection [code]idx[/code]. - - - - + + Returns the type of the output connection [code]idx[/code]. - - - - + + Returns the color set to [code]idx[/code] left (input) slot. - - - - + + Returns the color set to [code]idx[/code] right (output) slot. - - - - + + Returns the (integer) type of left (input) [code]idx[/code] slot. - - - - + + Returns the (integer) type of right (output) [code]idx[/code] slot. - - - - + + Returns [code]true[/code] if left (input) slot [code]idx[/code] is enabled, [code]false[/code] otherwise. - - - - + + Returns [code]true[/code] if right (output) slot [code]idx[/code] is enabled, [code]false[/code] otherwise. - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + Sets properties of the slot with ID [code]idx[/code]. If [code]enable_left[/code]/[code]right[/code], a port will appear and the slot will be able to be connected from this side. @@ -213,10 +174,8 @@ - - - - + + Emitted when the GraphNode is dragged. @@ -232,15 +191,13 @@ - - + Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]). - - + Emitted when any GraphNode's slot is updated. diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 6fc5a985e30..ffd8ae252b8 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -17,23 +17,17 @@ - - + Closes the current connection, allowing reuse of this [HTTPClient]. - - - - - - - - - - + + + + + Connects to a host. This needs to be done before any requests are sent. The host should not have http:// prepended but will strip the protocol identifier if provided. @@ -42,30 +36,26 @@ - - + Returns the response's body length. [b]Note:[/b] Some Web servers may not send a body length. In this case, the value returned will be [code]-1[/code]. If using chunked transfer encoding, the body length will also be [code]-1[/code]. - - + Returns the response's HTTP status code. - - + Returns the response headers. - - + Returns all response headers as a Dictionary of structure [code]{ "key": "value1; value2" }[/code] where the case-sensitivity of the keys and values is kept like the server delivers it. A value is a simple String, this string can have more than one value where "; " is used as separator. [b]Example:[/b] @@ -78,38 +68,32 @@ - - + Returns a [enum Status] constant. Need to call [method poll] in order to get status updates. - - + If [code]true[/code], this [HTTPClient] has a response available. - - + If [code]true[/code], this [HTTPClient] has a response that is chunked. - - + This needs to be called in order to have any request processed. Check results with [method get_status]. - - - - + + Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.: [codeblock] @@ -126,23 +110,17 @@ - - + Reads one chunk from the response. - - - - - - - - - - + + + + + Sends a request to the connected host. The URL parameter is usually just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]/index.php[/code]. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, [code]*[/code] is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component ([code]host:port[/code]). @@ -158,16 +136,11 @@ - - - - - - - - - - + + + + + Sends a raw request to the connected host. The URL parameter is usually just the part after the host, so for [code]http://somehost.com/index.php[/code], it is [code]/index.php[/code]. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, [code]*[/code] is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component ([code]host:port[/code]). diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index 280350d7bdb..6ab0ec9fdba 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -73,47 +73,37 @@ - - + Cancels the current request. - - + Returns the response body length. [b]Note:[/b] Some Web servers may not send a body length. In this case, the value returned will be [code]-1[/code]. If using chunked transfer encoding, the body length will also be [code]-1[/code]. - - + Returns the amount of bytes this HTTPRequest downloaded. - - + Returns the current status of the underlying [HTTPClient]. See [enum HTTPClient.Status]. - - - - - - - - - - - - + + + + + + Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request]. Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host. @@ -143,14 +133,10 @@ - - - - - - - - + + + + Emitted when a request is completed. diff --git a/doc/classes/HashingContext.xml b/doc/classes/HashingContext.xml index 4212dea89b2..471ddd0d15a 100644 --- a/doc/classes/HashingContext.xml +++ b/doc/classes/HashingContext.xml @@ -33,26 +33,21 @@ - - + Closes the current context, and return the computed hash. - - - - + + Starts a new hash computation of the given [code]type[/code] (e.g. [constant HASH_SHA256] to start computation of a SHA-256). - - - - + + Updates the computation with the given [code]chunk[/code] of data. diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index a28711576ff..86e61b3e190 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -10,41 +10,31 @@ - - - - + + Returns the value of the specified flag. - - - - + + Returns the value of the specified parameter. - - - - - - + + + If [code]true[/code], enables the specified flag. - - - - - - + + + Sets the value of the specified parameter. diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 5ee0771b8e5..eb8a3935863 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -10,33 +10,27 @@ - - - - + + Removes all of a [code]hostname[/code]'s cached references. If no [code]hostname[/code] is given, all cached IP addresses are removed. - - - - + + Removes a given item [code]id[/code] from the queue. This should be used to free a queue after it has completed to enable more queries to happen. - - + Returns all the user's current IPv4 and IPv6 addresses as an array. - - + Returns all network adapters as an array. Each adapter is a dictionary of the form: @@ -51,41 +45,31 @@ - - - - + + Returns a queued hostname's IP address, given its queue [code]id[/code]. Returns an empty string on error or if resolution hasn't happened yet (see [method get_resolve_item_status]). - - - - + + Returns a queued hostname's status as a [enum ResolverStatus] constant, given its queue [code]id[/code]. - - - - - - + + + Returns a given hostname's IPv4 or IPv6 address when resolved (blocking-type method). The address type returned depends on the [enum Type] constant given as [code]ip_type[/code]. - - - - - - + + + Creates a queue item to resolve a hostname to an IPv4 or IPv6 address depending on the [enum Type] constant given as [code]ip_type[/code]. Returns the queue ID if successful, or [constant RESOLVER_INVALID_ID] on error. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index ea7410f670f..750ad8c8530 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -13,324 +13,250 @@ - - - - - - - - + + + + Alpha-blends [code]src_rect[/code] from [code]src[/code] image to this image at coordinates [code]dest[/code]. - - - - - - - - - - + + + + + Alpha-blends [code]src_rect[/code] from [code]src[/code] image to this image using [code]mask[/code] image at coordinates [code]dst[/code]. Alpha channels are required for both [code]src[/code] and [code]mask[/code]. [code]dst[/code] pixels and [code]src[/code] pixels will blend if the corresponding mask pixel's alpha value is not 0. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. - - - - - - - - + + + + Copies [code]src_rect[/code] from [code]src[/code] image to this image at coordinates [code]dst[/code]. - - - - - - - - - - + + + + + Blits [code]src_rect[/code] area from [code]src[/code] image to this image at the coordinates given by [code]dst[/code]. [code]src[/code] pixel is copied onto [code]dst[/code] if the corresponding [code]mask[/code] pixel's alpha value is not 0. [code]src[/code] image and [code]mask[/code] image [b]must[/b] have the same size (width and height) but they can have different formats. - - - - + + Converts a bumpmap to a normalmap. A bumpmap provides a height offset per-pixel, while a normalmap provides a normal direction per pixel. - - + Removes the image's mipmaps. - - - - - - - - + + + + Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available. See [enum CompressMode] and [enum CompressSource] constants. - - - - + + Converts the image's format. See [enum Format] constants. - - - - + + Copies [code]src[/code] image to this image. - - - - - - - - - - + + + + + Creates an empty image of given size and format. See [enum Format] constants. If [code]use_mipmaps[/code] is [code]true[/code] then generate mipmaps for this image. See the [method generate_mipmaps]. - - - - - - - - - - - - + + + + + + Creates a new image of given size and format. See [enum Format] constants. Fills the image with the given raw data. If [code]use_mipmaps[/code] is [code]true[/code] then loads mipmaps for this image from [code]data[/code]. See [method generate_mipmaps]. - - - - - - + + + Crops the image to the given [code]width[/code] and [code]height[/code]. If the specified size is larger than the current size, the extra area is filled with black pixels. - - + Decompresses the image if it is compressed. Returns an error if decompress function is not available. - - + Returns [constant ALPHA_BLEND] if the image has data for alpha values. Returns [constant ALPHA_BIT] if all the alpha values are stored in a single bit. Returns [constant ALPHA_NONE] if no data for alpha values is found. - - + Stretches the image and enlarges it by a factor of 2. No interpolation is done. - - - - + + Fills the image with a given [Color]. - - + Blends low-alpha pixels with nearby pixels. - - + Flips the image horizontally. - - + Flips the image vertically. - - - - + + Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is [code]0[/code]. - - + Returns a copy of the image's raw data. - - + Returns the image's format. See [enum Format] constants. - - + Returns the image's height. - - - - + + Returns the offset where the image's mipmap with index [code]mipmap[/code] is stored in the [code]data[/code] dictionary. - - - - - - + + + Returns the color of the pixel at [code](x, y)[/code] if the image is locked. If the image is unlocked, it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. This is the same as [method get_pixelv], but two integer arguments instead of a Vector2 argument. - - - - + + Returns the color of the pixel at [code]src[/code] if the image is locked. If the image is unlocked, it always returns a [Color] with the value [code](0, 0, 0, 1.0)[/code]. This is the same as [method get_pixel], but with a Vector2 argument instead of two integer arguments. - - - - + + Returns a new image that is a copy of the image's area specified with [code]rect[/code]. - - + Returns the image's size (width and height). - - + Returns a [Rect2] enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible. - - + Returns the image's width. - - + Returns [code]true[/code] if the image has generated mipmaps. - - + Returns [code]true[/code] if the image is compressed. - - + Returns [code]true[/code] if the image has no data. - - + Returns [code]true[/code] if all the image's pixels have an alpha value of 0. Returns [code]false[/code] if any pixel has an alpha value higher than 0. - - - - + + Loads an image from file [code]path[/code]. See [url=https://docs.godotengine.org/en/3.3/getting_started/workflow/assets/importing_images.html#supported-image-formats]Supported image formats[/url] for a list of supported image formats and limitations. [b]Warning:[/b] This method should only be used in the editor or in cases when you need to load external images at run-time, such as images located at the [code]user://[/code] directory, and may not work in exported projects. @@ -338,139 +264,108 @@ - - - - + + Loads an image from the binary contents of a BMP file. [b]Note:[/b] Godot's BMP module doesn't support 16-bit per pixel images. Only 1-bit, 4-bit, 8-bit, 24-bit, and 32-bit per pixel images are supported. - - - - + + Loads an image from the binary contents of a JPEG file. - - - - + + Loads an image from the binary contents of a PNG file. - - - - + + Loads an image from the binary contents of a TGA file. - - - - + + Loads an image from the binary contents of a WebP file. - - + Locks the data for reading and writing access. Sends an error to the console if the image is not locked when reading or writing a pixel. - - + Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normalmap. A normalmap can add lots of detail to a 3D surface without increasing the polygon count. - - + Multiplies color values with alpha values. Resulting color values for a pixel are [code](color * alpha)/256[/code]. - - - - - - - - + + + + Resizes the image to the given [code]width[/code] and [code]height[/code]. New pixels are calculated using the [code]interpolation[/code] mode defined via [enum Interpolation] constants. - - - - - - + + + Resizes the image to the nearest power of 2 for the width and height. If [code]square[/code] is [code]true[/code] then set width and height to be the same. New pixels are calculated using the [code]interpolation[/code] mode defined via [enum Interpolation] constants. - - + Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. - - - - - - + + + Saves the image as an EXR file to [code]path[/code]. If [code]grayscale[/code] is [code]true[/code] and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. [b]Note:[/b] The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return [constant ERR_UNAVAILABLE] when it is called from an exported project. - - - - + + Saves the image as a PNG file to [code]path[/code]. - - + - - - - - - - - + + + + Sets the [Color] of the pixel at [code](x, y)[/code] if the image is locked. Example: [codeblock] @@ -484,12 +379,9 @@ - - - - - - + + + Sets the [Color] of the pixel at [code](dst.x, dst.y)[/code] if the image is locked. Note that the [code]dst[/code] values must be integers. Example: [codeblock] @@ -503,22 +395,19 @@ - - + Shrinks the image by a factor of 2. - - + Converts the raw data from the sRGB colorspace to a linear scale. - - + Unlocks the data and prevents changes. diff --git a/doc/classes/ImageTexture.xml b/doc/classes/ImageTexture.xml index c18ebc59f05..baac1720cc3 100644 --- a/doc/classes/ImageTexture.xml +++ b/doc/classes/ImageTexture.xml @@ -32,54 +32,41 @@ - - - - - - - - - - + + + + + Create a new [ImageTexture] with [code]width[/code] and [code]height[/code]. [code]format[/code] is a value from [enum Image.Format], [code]flags[/code] is any combination of [enum Texture.Flags]. - - - - - - + + + Initializes the texture by allocating and setting the data from an [Image] with [code]flags[/code] from [enum Texture.Flags]. An sRGB to linear color space conversion can take place, according to [enum Image.Format]. - - + Returns the format of the texture, one of [enum Image.Format]. - - - - + + Loads an image from a file path and creates a texture from it. [b]Note:[/b] the method is deprecated and will be removed in Godot 4.0, use [method Image.load] and [method create_from_image] instead. - - - - + + Replaces the texture's data with a new [Image]. [b]Note:[/b] The texture has to be initialized first with the [method create_from_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration, otherwise it has to be re-created with the [method create_from_image] method. @@ -87,10 +74,8 @@ - - - - + + Resizes the texture to the specified dimensions. diff --git a/doc/classes/ImmediateGeometry.xml b/doc/classes/ImmediateGeometry.xml index 4e45987f444..1218a7936ff 100644 --- a/doc/classes/ImmediateGeometry.xml +++ b/doc/classes/ImmediateGeometry.xml @@ -14,96 +14,74 @@ - - - - - - - - - - + + + + + Simple helper to draw an UV sphere with given latitude, longitude and radius. - - - - + + Adds a vertex in local coordinate space with the currently set color/uv/etc. - - - - - - + + + Begin drawing (and optionally pass a texture override). When done call [method end]. For more information on how this works, search for [code]glBegin()[/code] and [code]glEnd()[/code] references. For the type of primitive, see the [enum Mesh.PrimitiveType] enum. - - + Clears everything that was drawn using begin/end. - - + Ends a drawing context and displays the results. - - - - + + The current drawing color. - - - - + + The next vertex's normal. - - - - + + The next vertex's tangent (and binormal facing). - - - - + + The next vertex's UV. - - - - + + The next vertex's second layer UV. diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 49144c7e6de..20e0bd83c5e 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -13,12 +13,9 @@ - - - - - - + + + This will simulate pressing the specified action. The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action. @@ -26,28 +23,22 @@ - - - - + + If the specified action is already pressed, this will release it. - - - - - - + + + Adds a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices. - - + Returns the acceleration of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. Note this method returns an empty [Vector3] when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer. @@ -55,243 +46,192 @@ - - - - + + Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. - - + Returns an [Array] containing the device IDs of all currently connected joypads. - - + Returns the currently assigned cursor shape (see [enum CursorShape]). - - + Returns the gravity of the device's accelerometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. On Android the unit of measurement for each axis is m/s² while on iOS it's a multiple of the Earth's gravitational acceleration [code]g[/code] (~9.81 m/s²). - - + Returns the rotation rate in rad/s around a device's X, Y, and Z axes of the gyroscope sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. [b]Note:[/b] This method only works on Android and iOS. On other platforms, it always returns [constant Vector3.ZERO]. - - - - - - + + + Returns the current value of the joypad axis at given index (see [enum JoystickList]). - - - - + + Returns the index of the provided axis name. - - - - + + Receives a [enum JoystickList] axis and returns its equivalent name as a string. - - - - + + Returns the index of the provided button name. - - - - + + Receives a gamepad button from [enum JoystickList] and returns its equivalent name as a string. - - - - + + Returns a SDL2-compatible device GUID on platforms that use gamepad remapping. Returns [code]"Default Gamepad"[/code] otherwise. - - - - + + Returns the name of the joypad at the specified device index. - - - - + + Returns the duration of the current vibration effect in seconds. - - - - + + 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. - - + Returns the magnetic field strength in micro-Tesla for all axes of the device's magnetometer sensor, if the device has one. Otherwise, the method returns [constant Vector3.ZERO]. [b]Note:[/b] This method only works on Android, iOS and UWP. On other platforms, it always returns [constant Vector3.ZERO]. - - + Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time, the bits are added together. - - + Returns the mouse mode. See the constants for more information. - - - - + + Returns [code]true[/code] when the user starts pressing the action event, meaning it's [code]true[/code] only on the frame that the user pressed down the button. This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. - - - - + + Returns [code]true[/code] when the user stops pressing the action event, meaning it's [code]true[/code] only on the frame that the user released the button. - - - - + + Returns [code]true[/code] if you are pressing the action event. Note that if an action has multiple buttons assigned and more than one of them is pressed, releasing one button will release the action, even if some other button assigned to this action is still pressed. - - - - - - + + + Returns [code]true[/code] if you are pressing the joypad button (see [enum JoystickList]). - - - - + + Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in [enum JoystickList]. Unknown joypads are not expected to match these constants, but you can still retrieve events from them. - - - - + + Returns [code]true[/code] if you are pressing the key. You can pass a [enum KeyList] constant. - - - - + + Returns [code]true[/code] if you are pressing the mouse button specified with [enum ButtonList]. - - - - - - - - - - + + + + + Notifies the [Input] singleton that a connection has changed, to update the state for the [code]device[/code] index. This is used internally and should not have to be called from user scripts. See [signal joy_connection_changed] for the signal emitted when this is triggered internally. - - - - + + Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. Also generates [method Node._input] calls. Example: @@ -304,23 +244,17 @@ - - - - + + Removes all mappings from the internal database that match the given GUID. - - - - - - - - + + + + Sets a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified. Passing [code]null[/code] to the image parameter resets to the system cursor. See [enum CursorShape] for the list of shapes. [code]image[/code]'s size must be lower than 256×256. @@ -330,10 +264,8 @@ - - - - + + Sets the default cursor shape to be used in the viewport instead of [constant CURSOR_ARROW]. [b]Note:[/b] If you want to change the default cursor shape for [Control]'s nodes, use [member Control.mouse_default_cursor_shape] instead. @@ -341,64 +273,49 @@ - - - - + + Sets the mouse mode. See the constants for more information. - - - - + + Enables or disables the accumulation of similar input events sent by the operating system. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS. Input accumulation is enabled by default. It can be disabled to get slightly more precise/reactive input at the cost of increased CPU usage. In applications where drawing freehand lines is required, input accumulation should generally be disabled while the user is drawing the line to get results that closely follow the actual input. - - - - - - - - - - + + + + + Starts to vibrate the joypad. Joypads usually come with two rumble motors, a strong and a weak one. [code]weak_magnitude[/code] is the strength of the weak motor (between 0 and 1) and [code]strong_magnitude[/code] is the strength of the strong motor (between 0 and 1). [code]duration[/code] is the duration of the effect in seconds (a duration of 0 will try to play the vibration indefinitely). [b]Note:[/b] Not every hardware is compatible with long effect durations; it is recommended to restart an effect if it has to be played for more than a few seconds. - - - - + + Stops the vibration of the joypad. - - - - + + Vibrate Android and iOS devices. [b]Note:[/b] It needs [code]VIBRATE[/code] permission for Android at export settings. iOS does not support duration. - - - - + + Sets the mouse position to the specified vector. @@ -406,10 +323,8 @@ - - - - + + Emitted when a joypad device has been connected or disconnected. diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index 6e3f8718e8e..168614a85bc 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -14,97 +14,77 @@ - - - - + + Returns [code]true[/code] if the given input event and this input event can be added together (only for events of type [InputEventMouseMotion]). The given input event's position, global position and speed will be copied. The resulting [code]relative[/code] is a sum of both events. Both events' modifiers have to be identical. - - + Returns a [String] representation of the event. - - - - + + Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion]. - - - - + + Returns [code]true[/code] if this input event matches a pre-defined action of any type. - - - - - - + + + Returns [code]true[/code] if the given action is being pressed (and is not an echo event for [InputEventKey] events, unless [code]allow_echo[/code] is [code]true[/code]). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. - - - - + + Returns [code]true[/code] if the given action is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. - - + Returns [code]true[/code] if this input event's type is one that can be assigned to an input action. - - + Returns [code]true[/code] if this input event is an echo event (only for events of type [InputEventKey]). - - + Returns [code]true[/code] if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. - - - - + + Returns [code]true[/code] if the given input event is checking for the same key ([InputEventKey]), button ([InputEventJoypadButton]) or action ([InputEventAction]). - - - - - - + + + Returns a copy of the given input event which has been offset by [code]local_ofs[/code] and transformed by [code]xform[/code]. Relevant for events of type [InputEventMouseButton], [InputEventMouseMotion], [InputEventScreenTouch], [InputEventScreenDrag], [InputEventMagnifyGesture] and [InputEventPanGesture]. diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 386b74572ff..d322f42474f 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -11,8 +11,7 @@ - - + Returns the scancode combined with modifier keys such as [code]Shift[/code] or [code]Alt[/code]. See also [InputEventWithModifiers]. To get a human-readable representation of the [InputEventKey] with modifiers, use [code]OS.get_scancode_string(event.get_scancode_with_modifiers())[/code] where [code]event[/code] is the [InputEventKey]. diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index a14cc1f7068..717c287f39a 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -11,127 +11,97 @@ - - - - - - + + + Adds an [InputEvent] to an action. This [InputEvent] will trigger the action. - - - - - - + + + Removes an [InputEvent] from an action. - - - - + + Removes all events from an action. - - - - + + Returns a deadzone value for the action. - - - - - - + + + Returns [code]true[/code] if the action has the given [InputEvent] associated with it. - - - - - - + + + Sets a deadzone value for the action. - - - - - - + + + Adds an empty action to the [InputMap] with a configurable [code]deadzone[/code]. An [InputEvent] can then be added to this action with [method action_add_event]. - - - - + + Removes an action from the [InputMap]. - - - - - - + + + Returns [code]true[/code] if the given event is part of an existing action. This method ignores keyboard modifiers if the given [InputEvent] is not pressed (for proper release detection). See [method action_has_event] if you don't want this behavior. - - - - + + Returns an array of [InputEvent]s associated with a given action. - - + Returns an array of all actions in the [InputMap]. - - - - + + Returns [code]true[/code] if the [InputMap] has a registered action with the given name. - - + Clears all [InputEventAction] in the [InputMap] and load it anew from [ProjectSettings]. diff --git a/doc/classes/InstancePlaceholder.xml b/doc/classes/InstancePlaceholder.xml index d4b6cad78b1..b3864569f2e 100644 --- a/doc/classes/InstancePlaceholder.xml +++ b/doc/classes/InstancePlaceholder.xml @@ -11,36 +11,28 @@ - - - - - - + + + Not thread-safe. Use [method Object.call_deferred] if calling from a thread. - - + Gets the path to the [PackedScene] resource file that is loaded by default when calling [method replace_by_instance]. Not thread-safe. Use [method Object.call_deferred] if calling from a thread. - - - - + + - - - - + + Replaces this placeholder by the scene handed as an argument, or the original scene if no argument is given. As for all resources, the scene is loaded only if it's not loaded already. By manually loading the scene beforehand, delays caused by this function can be avoided. diff --git a/doc/classes/InterpolatedCamera.xml b/doc/classes/InterpolatedCamera.xml index 10ade57a493..c84820d353f 100644 --- a/doc/classes/InterpolatedCamera.xml +++ b/doc/classes/InterpolatedCamera.xml @@ -11,10 +11,8 @@ - - - - + + Sets the node to move toward and orient with. diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index e1fa85bbc0e..2d8639ba20e 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -12,385 +12,295 @@ - - - - - - + + + Adds an item to the item list with no text, only an icon. - - - - - - - - + + + + Adds an item to the item list with specified text. Specify an [code]icon[/code], or use [code]null[/code] as the [code]icon[/code] for a list item with no icon. If selectable is [code]true[/code], the list item will be selectable. - - + Removes all items from the list. - - + Ensure current selection is visible, adjusting the scroll position as necessary. - - - - - - + + + Returns the item index at the given [code]position[/code]. When there is no item at that point, -1 will be returned if [code]exact[/code] is [code]true[/code], and the closest item index will be returned otherwise. - - + Returns the number of items currently in the list. - - - - + + Returns the custom background color of the item specified by [code]idx[/code] index. - - - - + + Returns the custom foreground color of the item specified by [code]idx[/code] index. - - - - + + Returns the icon associated with the specified index. - - - - + + Returns a [Color] modulating item's icon at the specified index. - - - - + + Returns the region of item's icon used. The whole icon will be used if the region has no area. - - - - + + Returns the metadata value of the specified index. - - - - + + Returns the text associated with the specified index. - - - - + + Returns the tooltip hint associated with the specified index. - - + Returns an array with the indexes of the selected items. - - + Returns the [Object] ID associated with the list. - - + Returns [code]true[/code] if one or more items are selected. - - - - + + Returns [code]true[/code] if the item at the specified index is disabled. - - - - + + Returns [code]true[/code] if the item icon will be drawn transposed, i.e. the X and Y axes are swapped. - - - - + + Returns [code]true[/code] if the item at the specified index is selectable. - - - - + + Returns [code]true[/code] if the tooltip is enabled for specified item index. - - - - + + Returns [code]true[/code] if the item at the specified index is currently selected. - - - - - - + + + Moves item from index [code]from_idx[/code] to [code]to_idx[/code]. - - - - + + Removes the item specified by [code]idx[/code] index from the list. - - - - - - + + + Select the item at the specified index. [b]Note:[/b] This method does not trigger the item selection signal. - - - - - - + + + Sets the background color of the item specified by [code]idx[/code] index to the specified [Color]. - - - - - - + + + Sets the foreground color of the item specified by [code]idx[/code] index to the specified [Color]. - - - - - - + + + Disables (or enables) the item at the specified index. Disabled items cannot be selected and do not trigger activation signals (when double-clicking or pressing Enter). - - - - - - + + + Sets (or replaces) the icon's [Texture] associated with the specified index. - - - - - - + + + Sets a modulating [Color] of the item associated with the specified index. - - - - - - + + + Sets the region of item's icon used. The whole icon will be used if the region has no area. - - - - - - + + + Sets whether the item icon will be drawn transposed. - - - - - - + + + Sets a value (of any type) to be stored with the item associated with the specified index. - - - - - - + + + Allows or disallows selection of the item associated with the specified index. - - - - - - + + + Sets text of the item associated with the specified index. - - - - - - + + + Sets the tooltip hint for the item associated with the specified index. - - - - - - + + + Sets whether the tooltip hint is enabled for specified item index. - - + Sorts items in the list by their text. - - - - + + Ensures the item associated with the specified index is not selected. - - + Ensures there are no items selected. @@ -441,17 +351,14 @@ - - + Triggered when specified list item is activated via double-clicking or by pressing Enter. - - - - + + Triggered when specified list item has been selected via right mouse clicking. The click position is also provided to allow appropriate popup of context menus at the correct location. @@ -459,18 +366,15 @@ - - + Triggered when specified item has been selected. [member allow_reselect] must be enabled to reselect an item. - - - - + + Triggered when a multiple selection is altered on a list allowing multiple selection. @@ -481,8 +385,7 @@ - - + Triggered when a right mouse click is issued within the rect of the list but on empty space. [member allow_rmb_select] must be enabled. diff --git a/doc/classes/JSON.xml b/doc/classes/JSON.xml index 1a8aeacf620..68ebee79402 100644 --- a/doc/classes/JSON.xml +++ b/doc/classes/JSON.xml @@ -10,23 +10,17 @@ - - - - + + Parses a JSON-encoded string and returns a [JSONParseResult] containing the result. - - - - - - - - + + + + Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network. [b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types. diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml index 3d344f53696..d55d179be75 100644 --- a/doc/classes/JSONRPC.xml +++ b/doc/classes/JSONRPC.xml @@ -8,74 +8,52 @@ - - - - - - + + + - - - - - - - - + + + + - - - - - - + + + - - - - - - - - + + + + - - - - - - + + + - - - - + + - - - - - - + + + diff --git a/doc/classes/JavaClassWrapper.xml b/doc/classes/JavaClassWrapper.xml index fe7772a44fb..c5ef89522c6 100644 --- a/doc/classes/JavaClassWrapper.xml +++ b/doc/classes/JavaClassWrapper.xml @@ -8,10 +8,8 @@ - - - - + + diff --git a/doc/classes/JavaScript.xml b/doc/classes/JavaScript.xml index c0149986dea..c9deeeb88ce 100644 --- a/doc/classes/JavaScript.xml +++ b/doc/classes/JavaScript.xml @@ -12,12 +12,9 @@ - - - - - - + + + Execute the string [code]code[/code] as JavaScript code within the browser window. This is a call to the actual global JavaScript function [code]eval()[/code]. If [code]use_global_execution_context[/code] is [code]true[/code], the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment. diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index fafd23dd9d4..0d7b9260406 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -17,96 +17,74 @@ - - - - + + Returns [code]true[/code] if the specified [code]axis[/code] is locked. See also [member move_lock_x], [member move_lock_y] and [member move_lock_z]. - - + Returns the surface normal of the floor at the last collision point. Only valid after calling [method move_and_slide] or [method move_and_slide_with_snap] and when [method is_on_floor] returns [code]true[/code]. - - + Returns the linear velocity of the floor at the last collision point. Only valid after calling [method move_and_slide] or [method move_and_slide_with_snap] and when [method is_on_floor] returns [code]true[/code]. - - - - + + Returns a [KinematicCollision], which contains information about a collision that occurred during the last call to [method move_and_slide] or [method move_and_slide_with_snap]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). - - + Returns the number of times the body collided and changed direction during the last call to [method move_and_slide] or [method move_and_slide_with_snap]. - - + Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code]. - - + Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code]. - - + Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code]. - - - - - - - - - - + + + + + Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision], which contains information about the collision. If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given. - - - - - - - - - - - - - - + + + + + + + Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [KinematicBody] or [RigidBody], it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. @@ -120,47 +98,32 @@ - - - - - - - - - - - - - - - - + + + + + + + + Moves the body while keeping it attached to slopes. Similar to [method move_and_slide]. As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting [code]snap[/code] to [code](0, 0, 0)[/code] or by using [method move_and_slide] instead. - - - - - - + + + Locks or unlocks the specified [code]axis[/code] depending on the value of [code]lock[/code]. See also [member move_lock_x], [member move_lock_y] and [member move_lock_z]. - - - - - - - - + + + + Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur. diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index feb3f5fe5b0..c14c9b71ad6 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -16,24 +16,20 @@ - - + Returns the surface normal of the floor at the last collision point. Only valid after calling [method move_and_slide] or [method move_and_slide_with_snap] and when [method is_on_floor] returns [code]true[/code]. - - + Returns the linear velocity of the floor at the last collision point. Only valid after calling [method move_and_slide] or [method move_and_slide_with_snap] and when [method is_on_floor] returns [code]true[/code]. - - - - + + Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last call to [method move_and_slide] or [method move_and_slide_with_snap]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1). [b]Example usage:[/b] @@ -45,64 +41,48 @@ - - + Returns the number of times the body collided and changed direction during the last call to [method move_and_slide] or [method move_and_slide_with_snap]. - - + Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code]. - - + Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code]. - - + Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code]. - - - - - - - - - - + + + + + Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision2D], which contains information about the collision. If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given. - - - - - - - - - - - - - - + + + + + + + Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [KinematicBody2D] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes. This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed. @@ -116,36 +96,24 @@ - - - - - - - - - - - - - - - - + + + + + + + + Moves the body while keeping it attached to slopes. Similar to [method move_and_slide]. As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting [code]snap[/code] to [code](0, 0)[/code] or by using [method move_and_slide] instead. - - - - - - - - + + + + Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur. diff --git a/doc/classes/Label.xml b/doc/classes/Label.xml index ef49144fe88..b9319dad198 100644 --- a/doc/classes/Label.xml +++ b/doc/classes/Label.xml @@ -12,29 +12,25 @@ - - + Returns the amount of lines of text the Label has. - - + Returns the font size in pixels. - - + Returns the total number of printable characters in the text (excluding spaces and newlines). - - + Returns the number of lines shown. Useful if the [Label]'s height cannot currently display all lines. diff --git a/doc/classes/LargeTexture.xml b/doc/classes/LargeTexture.xml index de2da7ee796..2f299b9e6c3 100644 --- a/doc/classes/LargeTexture.xml +++ b/doc/classes/LargeTexture.xml @@ -11,75 +11,58 @@ - - - - - - + + + Adds [code]texture[/code] to this [LargeTexture], starting on offset [code]ofs[/code]. - - + Clears the [LargeTexture]. - - + Returns the number of pieces currently in this [LargeTexture]. - - - - + + Returns the offset of the piece with the index [code]idx[/code]. - - - - + + Returns the [Texture] of the piece with the index [code]idx[/code]. - - - - - - + + + Sets the offset of the piece with the index [code]idx[/code] to [code]ofs[/code]. - - - - - - + + + Sets the [Texture] of the piece with index [code]idx[/code] to [code]texture[/code]. - - - - + + Sets the size of this [LargeTexture]. diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index 70b2a0d10ad..44be958469e 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -12,21 +12,16 @@ - - - - + + Returns the value of the specified [enum Light.Param] parameter. - - - - - - + + + Sets the value of the specified [enum Light.Param] parameter. diff --git a/doc/classes/Line2D.xml b/doc/classes/Line2D.xml index 2a1590fe5fd..f71812d6778 100644 --- a/doc/classes/Line2D.xml +++ b/doc/classes/Line2D.xml @@ -13,56 +13,44 @@ - - - - - - + + + Adds a point at the [code]position[/code]. Appends the point at the end of the line. If [code]at_position[/code] is given, the point is inserted before the point number [code]at_position[/code], moving that point (and every point after) after the inserted point. If [code]at_position[/code] is not given, or is an illegal value ([code]at_position < 0[/code] or [code]at_position >= [method get_point_count][/code]), the point will be appended at the end of the point list. - - + Removes all points from the line. - - + Returns the Line2D's amount of points. - - - - + + Returns point [code]i[/code]'s position. - - - - + + Removes the point at index [code]i[/code] from the line. - - - - - - + + + Overwrites the position in point [code]i[/code] with the supplied [code]position[/code]. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 78f5c20fe5d..b3f275c2831 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -29,76 +29,61 @@ - - - - + + Adds [code]text[/code] after the cursor. If the resulting value is longer than [member max_length], nothing happens. - - + Erases the [LineEdit]'s [member text]. - - + Deletes one character at the cursor's current position (equivalent to pressing the [code]Delete[/code] key). - - - - - - + + + Deletes a section of the [member text] going from position [code]from_column[/code] to [code]to_column[/code]. Both parameters should be within the text's length. - - + Clears the current selection. - - + Returns the [PopupMenu] of this [LineEdit]. By default, this menu is displayed when right-clicking on the [LineEdit]. - - + Returns the scroll offset due to [member caret_position], as a number of characters. - - - - + + Executes a given action as defined in the [enum MenuItems] enum. - - - - - - + + + Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default, [code]from[/code] is at the beginning and [code]to[/code] at the end. [codeblock] @@ -110,8 +95,7 @@ - - + Selects the whole [String]. @@ -183,15 +167,13 @@ - - + Emitted when the text changes. - - + Emitted when the user presses [constant KEY_ENTER] on the [LineEdit]. diff --git a/doc/classes/Listener.xml b/doc/classes/Listener.xml index 89dbdcb48c7..2d36b6e79f6 100644 --- a/doc/classes/Listener.xml +++ b/doc/classes/Listener.xml @@ -11,30 +11,26 @@ - - + Disables the listener to use the current camera's listener instead. - - + Returns the listener's global orthonormalized [Transform]. - - + Returns [code]true[/code] if the listener was made current using [method make_current], [code]false[/code] otherwise. [b]Note:[/b] There may be more than one Listener marked as "current" in the scene tree, but only the one that was made current last will be used. - - + Enables the listener. This will override the current camera's listener. diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index 0201bfb4689..0d13443bf39 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -44,125 +44,99 @@ - - - - - - + + + Called when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. - - + Called before the program exits. - - - - - - + + + Called when the user performs an action in the system global menu (e.g. the Mac OS menu bar). - - - - + + Called each idle frame with the time since the last idle frame as argument (in seconds). Equivalent to [method Node._process]. If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame. - - + Called once during initialization. - - - - + + Called whenever an [InputEvent] is received by the main loop. - - - - + + Deprecated callback, does not do anything. Use [method _input_event] to parse text input. Will be removed in Godot 4.0. - - - - + + Called each physics frame with the time since the last physics frame as argument ([code]delta[/code], in seconds). Equivalent to [method Node._physics_process]. If implemented, the method must return a boolean value. [code]true[/code] ends the main loop, while [code]false[/code] lets it proceed to the next frame. - - + Should not be called manually, override [method _finalize] instead. Will be removed in Godot 4.0. - - - - + + Should not be called manually, override [method _idle] instead. Will be removed in Godot 4.0. - - + Should not be called manually, override [method _initialize] instead. Will be removed in Godot 4.0. - - - - + + Should not be called manually, override [method _input_event] instead. Will be removed in Godot 4.0. - - - - + + Should not be called manually, override [method _input_text] instead. Will be removed in Godot 4.0. - - - - + + Should not be called manually, override [method _iteration] instead. Will be removed in Godot 4.0. @@ -170,10 +144,8 @@ - - - - + + Emitted when a user responds to a permission request. diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index b07e3399bdc..8abf96c33e8 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -10,60 +10,46 @@ - - - - + + Returns a decoded [PoolByteArray] corresponding to the Base64-encoded string [code]base64_str[/code]. - - - - + + Returns a decoded string corresponding to the Base64-encoded string [code]base64_str[/code]. - - - - - - + + + Returns a decoded [Variant] corresponding to the Base64-encoded string [code]base64_str[/code]. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. - - - - + + Returns a Base64-encoded string of a given [PoolByteArray]. - - - - + + Returns a Base64-encoded string of the UTF-8 string [code]utf8_str[/code]. - - - - - - + + + Returns a Base64-encoded string of the [Variant] [code]variant[/code]. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code). diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index d7664aaa5c0..51cd55fe79c 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -12,17 +12,14 @@ - - + Returns the [PopupMenu] contained in this button. - - - - + + If [code]true[/code], shortcuts are disabled and cannot be used to trigger the button. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 87fd90a63f4..e4dd5b0c259 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -14,92 +14,75 @@ - - + Calculate a [ConvexPolygonShape] from the mesh. - - - - + + Calculate an outline mesh at a defined offset (margin) from the original mesh. [b]Note:[/b] This method typically returns the vertices in reverse order (e.g. clockwise to counterclockwise). - - + Calculate a [ConcavePolygonShape] from the mesh. - - + Generate a [TriangleMesh] from the mesh. - - + Returns the smallest [AABB] enclosing this mesh in local space. Not affected by [code]custom_aabb[/code]. See also [method VisualInstance.get_transformed_aabb]. [b]Note:[/b] This is only implemented for [ArrayMesh] and [PrimitiveMesh]. - - + Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. - - + Returns the amount of surfaces that the [Mesh] holds. - - - - + + Returns the arrays for the vertices, normals, uvs, etc. that make up the requested surface (see [method ArrayMesh.add_surface_from_arrays]). - - - - + + Returns the blend shape arrays for the requested surface. - - - - + + Returns a [Material] in a given surface. Surface is rendered using this material. - - - - - - + + + Sets a [Material] for a given surface. Surface will be rendered using this material. diff --git a/doc/classes/MeshDataTool.xml b/doc/classes/MeshDataTool.xml index e885231aef2..23a7b328beb 100644 --- a/doc/classes/MeshDataTool.xml +++ b/doc/classes/MeshDataTool.xml @@ -31,366 +31,281 @@ - - + Clears all data currently in MeshDataTool. - - - - + + Adds a new surface to specified [Mesh] with edited data. - - - - - - + + + Uses specified surface of given [Mesh] to populate data for MeshDataTool. Requires [Mesh] with primitive type [constant Mesh.PRIMITIVE_TRIANGLES]. - - + Returns the number of edges in this [Mesh]. - - - - + + Returns array of faces that touch given edge. - - - - + + Returns meta information assigned to given edge. - - - - - - + + + Returns index of specified vertex connected to given edge. Vertex argument can only be 0 or 1 because edges are comprised of two vertices. - - + Returns the number of faces in this [Mesh]. - - - - - - + + + Returns specified edge associated with given face. Edge argument must 2 or less because a face only has three edges. - - - - + + Returns the metadata associated with the given face. - - - - + + Calculates and returns the face normal of the given face. - - - - - - + + + Returns the specified vertex of the given face. Vertex argument must be 2 or less because faces contain three vertices. - - + Returns the [Mesh]'s format. Format is an integer made up of [Mesh] format flags combined together. For example, a mesh containing both vertices and normals would return a format of [code]3[/code] because [constant ArrayMesh.ARRAY_FORMAT_VERTEX] is [code]1[/code] and [constant ArrayMesh.ARRAY_FORMAT_NORMAL] is [code]2[/code]. See [enum ArrayMesh.ArrayFormat] for a list of format flags. - - + Returns the material assigned to the [Mesh]. - - - - + + Returns the vertex at given index. - - - - + + Returns the bones of the given vertex. - - - - + + Returns the color of the given vertex. - - + Returns the total number of vertices in [Mesh]. - - - - + + Returns an array of edges that share the given vertex. - - - - + + Returns an array of faces that share the given vertex. - - - - + + Returns the metadata associated with the given vertex. - - - - + + Returns the normal of the given vertex. - - - - + + Returns the tangent of the given vertex. - - - - + + Returns the UV of the given vertex. - - - - + + Returns the UV2 of the given vertex. - - - - + + Returns bone weights of the given vertex. - - - - - - + + + Sets the metadata of the given edge. - - - - - - + + + Sets the metadata of the given face. - - - - + + Sets the material to be used by newly-constructed [Mesh]. - - - - - - + + + Sets the position of the given vertex. - - - - - - + + + Sets the bones of the given vertex. - - - - - - + + + Sets the color of the given vertex. - - - - - - + + + Sets the metadata associated with the given vertex. - - - - - - + + + Sets the normal of the given vertex. - - - - - - + + + Sets the tangent of the given vertex. - - - - - - + + + Sets the UV of the given vertex. - - - - - - + + + Sets the UV2 of the given vertex. - - - - - - + + + Sets the bone weights of the given vertex. diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index 70e02461a04..c7747705599 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -14,58 +14,47 @@ - - + This helper creates a [StaticBody] child node with a [ConvexPolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing. - - + This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. - - + This helper creates a [StaticBody] child node with a [ConcavePolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing. - - - - + + Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance.material_override], the surface override [Material] defined in this [MeshInstance], or the surface [Material] defined in the [Mesh]. For example, if [member GeometryInstance.material_override] is used, all surfaces will return the override material. - - - - + + Returns the [Material] for a surface of the [Mesh] resource. - - + Returns the number of surface materials. - - - - - - + + + Sets the [Material] for a surface of the [Mesh] resource. diff --git a/doc/classes/MeshLibrary.xml b/doc/classes/MeshLibrary.xml index 702cc320f7f..5897240145c 100644 --- a/doc/classes/MeshLibrary.xml +++ b/doc/classes/MeshLibrary.xml @@ -12,172 +12,133 @@ - - + Clears the library. - - - - + + Creates a new item in the library with the given ID. You can get an unused ID from [method get_last_unused_item_id]. - - - - + + Returns the first item with the given name. - - + Returns the list of item IDs in use. - - - - + + Returns the item's mesh. - - - - + + Returns the item's name. - - - - + + Returns the item's navigation mesh. - - - - + + Returns the transform applied to the item's navigation mesh. - - - - + + When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using [method set_item_preview]. Returns an empty [Texture] if no preview was manually set in a running project. - - - - + + Returns an item's collision shapes. The array consists of each [Shape] followed by its [Transform]. - - + Gets an unused ID for a new item. - - - - + + Removes the item. - - - - - - + + + Sets the item's mesh. - - - - - - + + + Sets the item's name. This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name]. - - - - - - + + + Sets the item's navigation mesh. - - - - - - + + + Sets the transform to apply to the item's navigation mesh. - - - - - - + + + Sets a texture to use as the item's preview icon in the editor. - - - - - - + + + Sets an item's collision shapes. The array should consist of [Shape] objects, each followed by a [Transform] that will be applied to it. For shapes that should not have a transform, use [constant Transform.IDENTITY]. diff --git a/doc/classes/MultiMesh.xml b/doc/classes/MultiMesh.xml index 6bea8826640..9436dce54ff 100644 --- a/doc/classes/MultiMesh.xml +++ b/doc/classes/MultiMesh.xml @@ -15,53 +15,42 @@ - - + Returns the visibility axis-aligned bounding box in local space. See also [method VisualInstance.get_transformed_aabb]. - - - - + + Gets a specific instance's color. - - - - + + Returns the custom data that has been set for a specific instance. - - - - + + Returns the [Transform] of a specific instance. - - - - + + Returns the [Transform2D] of a specific instance. - - - - + + Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative. All data is packed in one large float array. An array may look like this: Transform for instance 1, color data for instance 1, custom data for instance 1, transform for instance 2, color data for instance 2, etc... @@ -69,46 +58,34 @@ - - - - - - + + + Sets the color of a specific instance by [i]multiplying[/i] the mesh's existing vertex colors. For the color to take effect, ensure that [member color_format] is non-[code]null[/code] on the [MultiMesh] and [member SpatialMaterial.vertex_color_use_as_albedo] is [code]true[/code] on the material. - - - - - - + + + Sets custom data for a specific instance. Although [Color] is used, it is just a container for 4 floating point numbers. The format of the number can change depending on the [enum CustomDataFormat] used. - - - - - - + + + Sets the [Transform] for a specific instance. - - - - - - + + + Sets the [Transform2D] for a specific instance. diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index 231c50a5e45..89d742be8d6 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -13,65 +13,54 @@ - - + Clears the current MultiplayerAPI network state (you shouldn't call this unless you know what you are doing). - - + Returns the peer IDs of all connected peers of this MultiplayerAPI's [member network_peer]. - - + Returns the unique peer ID of this MultiplayerAPI's [member network_peer]. - - + Returns the sender's peer ID for the RPC currently being executed. [b]Note:[/b] If not inside an RPC this method will return 0. - - + Returns [code]true[/code] if there is a [member network_peer] set. - - + Returns [code]true[/code] if this MultiplayerAPI's [member network_peer] is in server mode (listening for connections). - - + Method used for polling the MultiplayerAPI. You only need to worry about this if you are using [member Node.custom_multiplayer] override or you set [member SceneTree.multiplayer_poll] to [code]false[/code]. By default, [SceneTree] will poll its MultiplayerAPI for you. [b]Note:[/b] This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. [code]_process[/code], [code]physics[/code], [Thread]). - - - - - - - - + + + + Sends the given raw [code]bytes[/code] to a specific peer identified by [code]id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). Default ID is [code]0[/code], i.e. broadcast to all peers. @@ -105,24 +94,20 @@ - - + Emitted when this MultiplayerAPI's [member network_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). - - + Emitted when this MultiplayerAPI's [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. - - - - + + Emitted when this MultiplayerAPI's [member network_peer] receive a [code]packet[/code] with custom data (see [method send_bytes]). ID is the peer ID of the peer that sent the packet. diff --git a/doc/classes/Mutex.xml b/doc/classes/Mutex.xml index 46ea15bb1db..4f83e137a89 100644 --- a/doc/classes/Mutex.xml +++ b/doc/classes/Mutex.xml @@ -11,22 +11,19 @@ - - + Locks this [Mutex], blocks until it is unlocked by the current owner. - - + Tries locking this [Mutex], but does not block. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. - - + Unlocks this [Mutex], leaving it to other threads. diff --git a/doc/classes/Navigation.xml b/doc/classes/Navigation.xml index cbbdaf8ab08..b6ff59584a3 100644 --- a/doc/classes/Navigation.xml +++ b/doc/classes/Navigation.xml @@ -12,88 +12,65 @@ - - - - + + Returns the navigation point closest to the point given. Points are in local coordinate space. - - - - + + Returns the surface normal at the navigation point closest to the point given. Useful for rotating a navigation agent according to the navigation mesh it moves on. - - - - + + Returns the owner of the [NavigationMesh] which contains the navigation point closest to the point given. This is usually a [NavigationMeshInstance]. For meshes added via [method navmesh_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted). - - - - - - - - + + + + Returns the navigation point closest to the given line segment. When enabling [code]use_collision[/code], only considers intersection points between segment and navigation meshes. If multiple intersection points are found, the one closest to the segment start point is returned. - - - - - - - - + + + + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the agent properties associated with each [NavigationMesh] (radius, height, etc.) are considered in the path calculation, otherwise they are ignored. [b]Note:[/b] This method has known issues and will often return non-optimal paths. These issues will be fixed in Godot 4.0. - - - - - - - - + + + + Adds a [NavigationMesh]. Returns an ID for use with [method navmesh_remove] or [method navmesh_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner]. - - - - + + Removes the [NavigationMesh] with the given ID. - - - - - - + + + Sets the transform applied to the [NavigationMesh] with the given ID. diff --git a/doc/classes/Navigation2D.xml b/doc/classes/Navigation2D.xml index 6c0890947a1..af48e0dfa2a 100644 --- a/doc/classes/Navigation2D.xml +++ b/doc/classes/Navigation2D.xml @@ -12,66 +12,49 @@ - - - - + + Returns the navigation point closest to the point given. Points are in local coordinate space. - - - - + + Returns the owner of the [NavigationPolygon] which contains the navigation point closest to the point given. This is usually a [NavigationPolygonInstance]. For polygons added via [method navpoly_add], returns the owner that was given (or [code]null[/code] if the [code]owner[/code] parameter was omitted). - - - - - - - - + + + + Returns the path between two given points. Points are in local coordinate space. If [code]optimize[/code] is [code]true[/code] (the default), the path is smoothed by merging path segments where possible. [b]Note:[/b] This method has known issues and will often return non-optimal paths. These issues will be fixed in Godot 4.0. - - - - - - - - + + + + Adds a [NavigationPolygon]. Returns an ID for use with [method navpoly_remove] or [method navpoly_set_transform]. If given, a [Transform2D] is applied to the polygon. The optional [code]owner[/code] is used as return value for [method get_closest_point_owner]. - - - - + + Removes the [NavigationPolygon] with the given ID. - - - - - - + + + Sets the transform applied to the [NavigationPolygon] with the given ID. diff --git a/doc/classes/NavigationMesh.xml b/doc/classes/NavigationMesh.xml index b50a223f003..3cb651ce675 100644 --- a/doc/classes/NavigationMesh.xml +++ b/doc/classes/NavigationMesh.xml @@ -9,70 +9,54 @@ - - - - + + - - + - - - - + + - - - - + + - - - - + + - - + - - + - - - - - - + + + - - - - + + diff --git a/doc/classes/NavigationPolygon.xml b/doc/classes/NavigationPolygon.xml index edf85b9c229..0300d801a75 100644 --- a/doc/classes/NavigationPolygon.xml +++ b/doc/classes/NavigationPolygon.xml @@ -28,119 +28,95 @@ - - - - + + Appends a [PoolVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use. - - - - - - + + + Adds a [PoolVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. You have to call [method make_polygons_from_outlines] in order for this array to be converted to polygons that the engine will use. - - - - + + Adds a polygon using the indices of the vertices you get when calling [method get_vertices]. - - + Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them. - - + Clears the array of polygons, but it doesn't clear the array of outlines and vertices. - - - - + + Returns a [PoolVector2Array] containing the vertices of an outline that was created in the editor or by script. - - + Returns the number of outlines that were created in the editor or by script. - - - - + + Returns a [PoolIntArray] containing the indices of the vertices of a created polygon. - - + Returns the count of all polygons. - - + Returns a [PoolVector2Array] containing all the vertices being used to create the polygons. - - + Creates polygons from the outlines added in the editor or by script. - - - - + + Removes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. - - - - - - + + + Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. - - - - + + Sets the vertices that can be then indexed to create polygons with the [method add_polygon] method. diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index 270549401e3..7b5f56bb2b5 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -13,38 +13,32 @@ - - + Returns the current state of the connection. See [enum ConnectionStatus]. - - + Returns the ID of the [NetworkedMultiplayerPeer] who sent the most recent packet. - - + Returns the ID of this [NetworkedMultiplayerPeer]. - - + Waits up to 1 second to receive a new network event. - - - - + + Sets the peer to which packets will be sent. The [code]id[/code] can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is [constant TARGET_PEER_BROADCAST]. @@ -71,15 +65,13 @@ - - + Emitted by the server when a client connects. - - + Emitted by the server when a client disconnects. diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 49b5409ac58..88b74856433 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -10,21 +10,16 @@ - - - - + + Returns the size of the margin identified by the given [enum Margin] constant. - - - - - - + + + Sets the size of the margin identified by the given [enum Margin] constant to [code]value[/code] in pixels. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 0cf20ba076c..fd112dc3894 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -22,24 +22,21 @@ - - + Called when the node enters the [SceneTree] (e.g. upon instancing, scene changing, or after calling [method add_child] in a script). If the node has children, its [method _enter_tree] callback will be called first, and then that of the children. Corresponds to the [constant NOTIFICATION_ENTER_TREE] notification in [method Object._notification]. - - + Called when the node is about to leave the [SceneTree] (e.g. upon freeing, scene changing, or after calling [method remove_child] in a script). If the node has children, its [method _exit_tree] callback will be called last, after all its children have left the tree. Corresponds to the [constant NOTIFICATION_EXIT_TREE] notification in [method Object._notification] and signal [signal tree_exiting]. To get notified when the node has already left the active tree, connect to the [signal tree_exited]. - - + The string returned from this method is displayed as a warning in the Scene Dock if the script that overrides it is a [code]tool[/code] script. Returning an empty string produces no warning. @@ -47,10 +44,8 @@ - - - - + + Called when there is an input event. The input event propagates up through the node tree until a node consumes it. It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_input]. @@ -60,10 +55,8 @@ - - - - + + Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [code]delta[/code] variable should be constant. [code]delta[/code] is in seconds. It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_physics_process]. @@ -72,10 +65,8 @@ - - - - + + Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [code]delta[/code] time since the previous frame is not constant. [code]delta[/code] is in seconds. It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process]. @@ -84,8 +75,7 @@ - - + Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their [method _ready] callbacks get triggered first, and the parent node will receive the ready notification afterwards. Corresponds to the [constant NOTIFICATION_READY] notification in [method Object._notification]. See also the [code]onready[/code] keyword for variables. @@ -94,10 +84,8 @@ - - - - + + Called when an [InputEvent] hasn't been consumed by [method _input] or any GUI. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_input]. @@ -107,10 +95,8 @@ - - - - + + Called when an [InputEventKey] hasn't been consumed by [method _input] or any GUI. The input event propagates up through the node tree until a node consumes it. It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_key_input]. @@ -120,12 +106,9 @@ - - - - - - + + + Adds a child node. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have a human-readable name based on the name of the node being instanced instead of its type. @@ -139,43 +122,33 @@ - - - - - - - - + + + + Adds [code]child_node[/code] as a child. The child is placed below the given [code]node[/code] in the list of children. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have a human-readable name based on the name of the node being instanced instead of its type. - - - - - - + + + Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see [method is_inside_tree]). See notes in the description, and the group methods in [SceneTree]. The [code]persistent[/code] option is used when packing node to [PackedScene] and saving to file. Non-persistent groups aren't stored. - - + Returns [code]true[/code] if the node can process while the scene tree is paused (see [member pause_mode]). Always returns [code]true[/code] if the scene tree is not paused, and [code]false[/code] if the node is not in the tree. - - - - + + Duplicates the node, returning a new node. You can fine-tune the behavior using the [code]flags[/code] (see [enum DuplicateFlags]). @@ -183,14 +156,10 @@ - - - - - - - - + + + + Finds a descendant of this node whose name matches [code]mask[/code] as in [method String.match] (i.e. case-sensitive, but [code]"*"[/code] matches zero or more characters and [code]"?"[/code] matches any single character except [code]"."[/code]). [b]Note:[/b] It does not match against the full path, just against individual node names. @@ -199,10 +168,8 @@ - - - - + + Finds the first parent of the current node whose name matches [code]mask[/code] as in [method String.match] (i.e. case-sensitive, but [code]"*"[/code] matches zero or more characters and [code]"?"[/code] matches any single character except [code]"."[/code]). [b]Note:[/b] It does not match against the full path, just against individual node names. @@ -210,55 +177,46 @@ - - - - + + Returns a child node by its index (see [method get_child_count]). This method is often used for iterating all children of a node. To access a child node via its name, use [method get_node]. - - + Returns the number of child nodes. - - + Returns an array of references to node's children. - - + Returns an array listing the groups that the node is a member of. - - + Returns the node's index, i.e. its position among the siblings of its parent. - - + Returns the peer ID of the network master for this node. See [method set_network_master]. - - - - + + Fetches a node. The [NodePath] can be either a relative path (from the current node) or an absolute path (in the scene tree) to a node. If the path does not exist, a [code]null instance[/code] is returned and an error is logged. Attempts to access methods on the return value will result in an "Attempt to call <method> on a null instance." error. [b]Note:[/b] Fetching absolute paths only works when the node is inside the scene tree (see [method is_inside_tree]). @@ -283,10 +241,8 @@ - - - - + + Fetches a node and one of its resources as specified by the [NodePath]'s subname (e.g. [code]Area2D/CollisionShape2D:shape[/code]). If several nested resources are specified in the [NodePath], the last one will be fetched. The return value is an array of size 3: the first index points to the [Node] (or [code]null[/code] if not found), the second index points to the [Resource] (or [code]null[/code] if not found), and the third index is the remaining [NodePath], if any. @@ -299,215 +255,178 @@ - - - - + + Similar to [method get_node], but does not log an error if [code]path[/code] does not point to a valid [Node]. - - + Returns the parent node of the current node, or a [code]null instance[/code] if the node lacks a parent. - - + Returns the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_tree]). - - - - + + Returns the relative [NodePath] from this node to the specified [code]node[/code]. Both nodes must be in the same scene or the function will fail. - - + Returns the time elapsed (in seconds) since the last physics-bound frame (see [method _physics_process]). This is always a constant value in physics processing unless the frames per second is changed via [member Engine.iterations_per_second]. - - + Returns the node's order in the scene tree branch. For example, if called on the first child node the position is [code]0[/code]. - - + Returns the time elapsed (in seconds) since the last process callback. This value may vary from frame to frame. - - + Returns [code]true[/code] if this is an instance load placeholder. See [InstancePlaceholder]. - - + Returns the [SceneTree] that contains this node. - - + Returns the node's [Viewport]. - - - - + + Returns [code]true[/code] if the node that the [NodePath] points to exists. - - - - + + Returns [code]true[/code] if the [NodePath] points to a valid node and its subname points to a valid resource, e.g. [code]Area2D/CollisionShape2D:shape[/code]. Properties with a non-[Resource] type (e.g. nodes or primitive math types) are not considered resources. - - - - + + Returns [code]true[/code] if the given node is a direct or indirect child of the current node. - - + Returns [code]true[/code] if the node is folded (collapsed) in the Scene dock. - - - - + + Returns [code]true[/code] if the given node occurs later in the scene hierarchy than the current node. - - - - + + Returns [code]true[/code] if this node is in the specified group. See notes in the description, and the group methods in [SceneTree]. - - + Returns [code]true[/code] if this node is currently inside a [SceneTree]. - - + Returns [code]true[/code] if the local system is the master of this node. - - + Returns [code]true[/code] if physics processing is enabled (see [method set_physics_process]). - - + Returns [code]true[/code] if internal physics processing is enabled (see [method set_physics_process_internal]). - - + Returns [code]true[/code] if processing is enabled (see [method set_process]). - - + Returns [code]true[/code] if the node is processing input (see [method set_process_input]). - - + Returns [code]true[/code] if internal processing is enabled (see [method set_process_internal]). - - + Returns [code]true[/code] if the node is processing unhandled input (see [method set_process_unhandled_input]). - - + Returns [code]true[/code] if the node is processing unhandled key input (see [method set_process_unhandled_key_input]). - - - - - - + + + Moves a child node to a different position (order) among the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. - - + Prints all stray nodes (nodes outside the [SceneTree]). Used for debugging. Works only in debug builds. - - + Prints the tree to stdout. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the [method get_node] function. [b]Example output:[/b] @@ -522,8 +441,7 @@ - - + Similar to [method print_tree], this prints the tree to stdout. This version displays a more graphical representation similar to what is displayed in the scene inspector. It is useful for inspecting larger trees. [b]Example output:[/b] @@ -538,293 +456,224 @@ - - - - - - - - + + + + Calls the given method (if present) with the arguments given in [code]args[/code] on this node and recursively on all its children. If the [code]parent_first[/code] argument is [code]true[/code], the method will be called on the current node first, then on all its children. If [code]parent_first[/code] is [code]false[/code], the children will be called first. - - - - + + Notifies the current node and all its children recursively by calling [method Object.notification] on all of them. - - + Queues a node for deletion at the end of the current frame. When deleted, all of its child nodes will be deleted as well. This method ensures it's safe to delete the node, contrary to [method Object.free]. Use [method Object.is_queued_for_deletion] to check whether a node will be deleted at the end of the frame. [b]Important:[/b] If you have a variable pointing to a node, it will [i]not[/i] be assigned to [code]null[/code] once the node is freed. Instead, it will point to a [i]previously freed instance[/i] and you should validate it with [method @GDScript.is_instance_valid] before attempting to call its methods or access its properties. - - + Moves this node to the bottom of parent node's children hierarchy. This is often useful in GUIs ([Control] nodes), because their order of drawing depends on their order in the tree. The top Node is drawn first, then any siblings below the top Node in the hierarchy are successively drawn on top of it. After using [code]raise[/code], a Control will be drawn on top of its siblings. - - + Removes a node and sets all its children as children of the parent node (if it exists). All event subscriptions that pass by the removed node will be unsubscribed. - - - - + + Removes a child node. The node is NOT deleted and must be deleted manually. - - - - + + Removes a node from a group. See notes in the description, and the group methods in [SceneTree]. - - - - - - + + + Replaces a node in a scene by the given one. Subscriptions that pass through this node will be lost. - - + Requests that [code]_ready[/code] be called again. Note that the method won't be called immediately, but is scheduled for when the node is added to the scene tree again (see [method _ready]). [code]_ready[/code] is called only for the node which requested it, which means that you need to request ready for each child if you want them to call [code]_ready[/code] too (in which case, [code]_ready[/code] will be called in the same order as it would normally). - - - - + + Sends a remote procedure call request for the given [code]method[/code] to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same [NodePath], including the exact same node name. Behaviour depends on the RPC configuration for the given method, see [method rpc_config]. Methods are not exposed to RPCs by default. See also [method rset] and [method rset_config] for properties. Returns an empty [Variant]. [b]Note:[/b] You can only safely use RPCs on clients after you received the [code]connected_to_server[/code] signal from the [SceneTree]. You also need to keep track of the connection state, either by the [SceneTree] signals like [code]server_disconnected[/code] or by checking [code]SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED[/code]. - - - - - - + + + Changes the RPC mode for the given [code]method[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, methods are not exposed to networking (and RPCs). See also [method rset] and [method rset_config] for properties. - - - - - - + + + Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns an empty [Variant]. - - - - + + Sends a [method rpc] using an unreliable protocol. Returns an empty [Variant]. - - - - - - + + + Sends a [method rpc] to a specific peer identified by [code]peer_id[/code] using an unreliable protocol (see [method NetworkedMultiplayerPeer.set_target_peer]). Returns an empty [Variant]. - - - - - - + + + Remotely changes a property's value on other peers (and locally). Behaviour depends on the RPC configuration for the given property, see [method rset_config]. See also [method rpc] for RPCs for methods, most information applies to this method as well. - - - - - - + + + Changes the RPC mode for the given [code]property[/code] to the given [code]mode[/code]. See [enum MultiplayerAPI.RPCMode]. An alternative is annotating methods and properties with the corresponding keywords ([code]remote[/code], [code]master[/code], [code]puppet[/code], [code]remotesync[/code], [code]mastersync[/code], [code]puppetsync[/code]). By default, properties are not exposed to networking (and RPCs). See also [method rpc] and [method rpc_config] for methods. - - - - - - - - + + + + Remotely changes the property's value on a specific peer identified by [code]peer_id[/code] (see [method NetworkedMultiplayerPeer.set_target_peer]). - - - - - - + + + Remotely changes the property's value on other peers (and locally) using an unreliable protocol. - - - - - - - - + + + + Remotely changes property's value on a specific peer identified by [code]peer_id[/code] using an unreliable protocol (see [method NetworkedMultiplayerPeer.set_target_peer]). - - - - + + Sets the folded state of the node in the Scene dock. - - - - - - + + + Sets the node's network master to the peer with the given peer ID. The network master is the peer that has authority over the node on the network. Useful in conjunction with the [code]master[/code] and [code]puppet[/code] keywords. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server). If [code]recursive[/code], the given peer is recursively set as the master for all children of this node. - - - - + + Enables or disables physics (i.e. fixed framerate) processing. When a node is being processed, it will receive a [constant NOTIFICATION_PHYSICS_PROCESS] at a fixed (usually 60 FPS, see [member Engine.iterations_per_second] to change) interval (and the [method _physics_process] callback will be called if exists). Enabled automatically if [method _physics_process] is overridden. Any calls to this before [method _ready] will be ignored. - - - - + + Enables or disables internal physics for this node. Internal physics processing happens in isolation from the normal [method _physics_process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting ([method set_physics_process]). Only useful for advanced uses to manipulate built-in nodes' behavior. [b]Warning:[/b] Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported. - - - - + + Enables or disables processing. When a node is being processed, it will receive a [constant NOTIFICATION_PROCESS] on every drawn frame (and the [method _process] callback will be called if exists). Enabled automatically if [method _process] is overridden. Any calls to this before [method _ready] will be ignored. - - - - + + Enables or disables input processing. This is not required for GUI controls! Enabled automatically if [method _input] is overridden. Any calls to this before [method _ready] will be ignored. - - - - + + Enables or disabled internal processing for this node. Internal processing happens in isolation from the normal [method _process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting ([method set_process]). Only useful for advanced uses to manipulate built-in nodes' behavior. [b]Warning:[/b] Built-in Nodes rely on the internal processing for their own logic, so changing this value from your code may lead to unexpected behavior. Script access to this internal logic is provided for specific advanced uses, but is unsafe and not supported. - - - - + + Enables unhandled input processing. This is not required for GUI controls! It enables the node to receive all input that was not previously handled (usually by a [Control]). Enabled automatically if [method _unhandled_input] is overridden. Any calls to this before [method _ready] will be ignored. - - - - + + Enables unhandled key input processing. Enabled automatically if [method _unhandled_key_input] is overridden. Any calls to this before [method _ready] will be ignored. - - - - + + Sets whether this is an instance load placeholder. See [InstancePlaceholder]. - - + Updates the warning displayed for this node in the Scene Dock. Use [method _get_configuration_warning] to setup the warning message to display. diff --git a/doc/classes/Node2D.xml b/doc/classes/Node2D.xml index 82e8ac47876..83638ad66ad 100644 --- a/doc/classes/Node2D.xml +++ b/doc/classes/Node2D.xml @@ -12,104 +12,80 @@ - - - - + + Multiplies the current scale by the [code]ratio[/code] vector. - - - - + + Returns the angle between the node and the [code]point[/code] in radians. - - - - + + Returns the [Transform2D] relative to this node's parent. - - - - + + Adds the [code]offset[/code] vector to the node's global position. - - - - + + Rotates the node so it points towards the [code]point[/code], which is expected to use global coordinates. - - - - - - + + + Applies a local translation on the node's X axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement. - - - - - - + + + Applies a local translation on the node's Y axis based on the [method Node._process]'s [code]delta[/code]. If [code]scaled[/code] is [code]false[/code], normalizes the movement. - - - - + + Applies a rotation to the node, in radians, starting from its current rotation. - - - - + + Transforms the provided local position into a position in global coordinate space. The input is expected to be local relative to the [Node2D] it is called on. e.g. Applying this method to the positions of child nodes will correctly transform their positions into the global coordinate space, but applying it to a node's own position will give an incorrect result, as it will incorporate the node's own transformation into its global position. - - - - + + Transforms the provided global position into a position in local coordinate space. The output will be local relative to the [Node2D] it is called on. e.g. It is appropriate for determining the positions of child nodes, but it is not appropriate for determining its own position relative to its parent. - - - - + + Translates the node by the given [code]offset[/code] in local coordinates. diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 101c6b78d70..de22f7ac03e 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -26,10 +26,8 @@ - - - - + + Creates a NodePath from a string, e.g. [code]"Path2D/PathFollow2D/Sprite:texture:size"[/code]. A path is absolute if it starts with a slash. Absolute paths are only valid in the global scene tree, not within individual scenes. In a relative path, [code]"."[/code] and [code]".."[/code] indicate the current node and its parent. The "subnames" optionally included after the path to the target node can point to resources or properties, and can also be nested. @@ -51,8 +49,7 @@ - - + Returns a node path with a colon character ([code]:[/code]) prepended, transforming it to a pure property path with no node name (defaults to resolving from the current node). [codeblock] @@ -65,8 +62,7 @@ - - + Returns all subnames concatenated with a colon character ([code]:[/code]) as separator, i.e. the right side of the first colon in a node path. [codeblock] @@ -76,10 +72,8 @@ - - - - + + Gets the node name indicated by [code]idx[/code] (0 to [method get_name_count]). [codeblock] @@ -91,18 +85,15 @@ - - + Gets the number of node names which make up the path. Subnames (see [method get_subname_count]) are not included. For example, [code]"Path2D/PathFollow2D/Sprite"[/code] has 3 names. - - - - + + Gets the resource or property name indicated by [code]idx[/code] (0 to [method get_subname_count]). [codeblock] @@ -113,23 +104,20 @@ - - + Gets the number of resource or property names ("subnames") in the path. Each subname is listed after a colon character ([code]:[/code]) in the node path. For example, [code]"Path2D/PathFollow2D/Sprite:texture:load_path"[/code] has 2 subnames. - - + Returns [code]true[/code] if the node path is absolute (as opposed to relative), which means that it starts with a slash character ([code]/[/code]). Absolute node paths can be used to access the root node ([code]"/root"[/code]) or autoloads (e.g. [code]"/global"[/code] if a "global" autoload was registered). - - + Returns [code]true[/code] if the node path is empty. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 930f0c9ee47..57d5e2afe2d 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -11,78 +11,63 @@ - - - - - - + + + Displays a modal dialog box using the host OS' facilities. Execution is blocked until the dialog is closed. - - + Returns [code]true[/code] if the host OS allows drawing. - - + Returns [code]true[/code] if the current host platform is using multiple threads. - - + Centers the window on the screen if in windowed mode. - - + Shuts down system MIDI driver. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + Delay execution of the current thread by [code]msec[/code] milliseconds. [code]msec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_msec] will do nothing and will print an error message. - - - - + + Delay execution of the current thread by [code]usec[/code] microseconds. [code]usec[/code] must be greater than or equal to [code]0[/code]. Otherwise, [method delay_usec] will do nothing and will print an error message. - - - - + + Dumps the memory allocation ringlist to a file (only works in debug). Entry format per line: "Address - Size - Description". - - - - + + Dumps all used resources to file (only works in debug). Entry format per line: "Resource Type : Resource Location". @@ -90,18 +75,12 @@ - - - - - - - - - - - - + + + + + + Execute the file at the given path with the arguments passed as an array of strings. Platform path resolution will take place. The resolved file must exist and be executable. The arguments are used in the given order and separated by a space, so [code]OS.execute("ping", ["-w", "3", "godotengine.org"], false)[/code] will resolve to [code]ping -w 3 godotengine.org[/code] in the system's shell. @@ -126,33 +105,27 @@ - - - - + + Returns the scancode of the given string (e.g. "Escape"). - - + Returns the total number of available audio drivers. - - - - + + Returns the audio driver name for the given index. - - + Returns the command-line arguments passed to the engine. Command-line arguments can be written in any form, including both [code]--key value[/code] and [code]--key=value[/code] forms so they can be properly parsed, as long as custom command-line arguments do not conflict with engine arguments. @@ -169,8 +142,7 @@ - - + Returns an array of MIDI device names. The returned array will be empty if the system MIDI driver has not previously been initialised with [method open_midi_inputs]. @@ -178,75 +150,62 @@ - - + Returns the currently used video driver, using one of the values from [enum VideoDriver]. - - - - + + Returns current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]dst[/code] (Daylight Savings Time). - - - - + + Returns current datetime as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]weekday[/code], [code]dst[/code] (Daylight Savings Time), [code]hour[/code], [code]minute[/code], [code]second[/code]. - - - - + + Gets a dictionary of time values corresponding to the given UNIX epoch time (in seconds). The returned Dictionary's values will be the same as [method get_datetime], with the exception of Daylight Savings Time as it cannot be determined from the epoch. - - + Returns the total amount of dynamic memory used (only works in debug). - - - - + + Returns the value of an environment variable. Returns an empty string if the environment variable doesn't exist. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. - - + Returns the path to the current engine executable. - - + With this function, you can get the list of dangerous permissions that have been granted to the Android application. [b]Note:[/b] This method is implemented on Android. - - + Returns the IME cursor position (the currently-edited portion of the string) relative to the characters in the composition string. [constant MainLoop.NOTIFICATION_OS_IME_UPDATE] is sent to the application to notify it of changes to the IME cursor position. @@ -254,8 +213,7 @@ - - + Returns the IME intermediate composition string. [constant MainLoop.NOTIFICATION_OS_IME_UPDATE] is sent to the application to notify it of changes to the IME composition string. @@ -263,8 +221,7 @@ - - + Returns the current latin keyboard variant as a String. Possible return values are: [code]"QWERTY"[/code], [code]"AZERTY"[/code], [code]"QZERTY"[/code], [code]"DVORAK"[/code], [code]"NEO"[/code], [code]"COLEMAK"[/code] or [code]"ERROR"[/code]. @@ -272,105 +229,89 @@ - - + Returns the host OS locale. - - + Returns the model name of the current device. [b]Note:[/b] This method is implemented on Android and iOS. Returns [code]"GenericDevice"[/code] on unsupported platforms. - - + Returns the name of the host OS. Possible values are: [code]"Android"[/code], [code]"iOS"[/code], [code]"HTML5"[/code], [code]"OSX"[/code], [code]"Server"[/code], [code]"Windows"[/code], [code]"UWP"[/code], [code]"X11"[/code]. - - - - + + Returns internal structure pointers for use in GDNative plugins. [b]Note:[/b] This method is implemented on Linux and Windows (other OSs will soon be supported). - - + Returns the amount of battery left in the device as a percentage. Returns [code]-1[/code] if power state is unknown. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - + Returns an estimate of the time left in seconds before the device runs out of battery. Returns [code]-1[/code] if power state is unknown. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - + Returns the current state of the device regarding battery and power. See [enum PowerState] constants. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - + Returns the project's process ID. [b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows. - - + Returns the number of threads available on the host machine. - - + Returns the window size including decorations like window borders. - - - - + + Returns the given scancode as a string (e.g. Return values: [code]"Escape"[/code], [code]"Shift+Escape"[/code]). See also [member InputEventKey.scancode] and [method InputEventKey.get_scancode_with_modifiers]. - - + Returns the number of displays attached to the host machine. - - - - + + Returns the dots per inch density of the specified screen. If [code]screen[/code] is [/code]-1[/code] (the default value), the current screen will be used. [b]Note:[/b] On macOS, returned value is inaccurate if fractional display scaling mode is used. @@ -387,8 +328,7 @@ - - + Return the greatest scale factor of all screens. [b]Note:[/b] On macOS returned value is [code]2.0[/code] if there is at least one hiDPI (Retina) screen in the system, and [code]1.0[/code] in all other cases. @@ -396,19 +336,15 @@ - - - - + + Returns the position of the specified screen by index. If [code]screen[/code] is [/code]-1[/code] (the default value), the current screen will be used. - - - - + + Return the scale factor of the specified screen by index. If [code]screen[/code] is [/code]-1[/code] (the default value), the current screen will be used. [b]Note:[/b] On macOS returned value is [code]2.0[/code] for hiDPI (Retina) screen, and [code]1.0[/code] for all other cases. @@ -416,118 +352,99 @@ - - - - + + Returns the dimensions in pixels of the specified screen. If [code]screen[/code] is [/code]-1[/code] (the default value), the current screen will be used. - - + Returns the amount of time in milliseconds it took for the boot logo to appear. - - + Returns the maximum amount of static memory used (only works in debug). - - + Returns the amount of static memory being used by the program in bytes. - - - - + + Returns the actual path to commonly used folders across different platforms. Available locations are specified in [enum SystemDir]. [b]Note:[/b] This method is implemented on Android, Linux, macOS and Windows. - - + Returns the epoch time of the operating system in milliseconds. - - + Returns the epoch time of the operating system in seconds. - - + Returns the total number of available tablet drivers. [b]Note:[/b] This method is implemented on Windows. - - - - + + Returns the tablet driver name for the given index. [b]Note:[/b] This method is implemented on Windows. - - + Returns the ID of the current thread. This can be used in logs to ease debugging of multi-threaded applications. [b]Note:[/b] Thread IDs are not deterministic and may be reused across application restarts. - - + Returns the amount of time passed in milliseconds since the engine started. - - + Returns the amount of time passed in microseconds since the engine started. - - - - + + Returns current time as a dictionary of keys: hour, minute, second. - - + Returns the current time zone as a dictionary with the keys: bias and name. - - + Returns a string that is unique to the device. [b]Note:[/b] This string may change without notice if the user reinstalls/upgrades their operating system or changes their hardware. This means it should generally not be used to encrypt persistent data as the data saved before an unexpected ID change would become inaccessible. The returned string may also be falsified using external programs, so do not rely on the string returned by [method get_unique_id] for security purposes. @@ -535,18 +452,15 @@ - - + Returns the current UNIX epoch timestamp in seconds. [b]Important:[/b] This is the system clock that the user can manually set. [b]Never use[/b] this method for precise time calculation since its results are also subject to automatic adjustments by the operating system. [b]Always use[/b] [method get_ticks_usec] or [method get_ticks_msec] for precise time calculation instead, since they are guaranteed to be monotonic (i.e. never decrease). - - - - + + Gets an epoch time value from a dictionary of time values. [code]datetime[/code] must be populated with the following keys: [code]year[/code], [code]month[/code], [code]day[/code], [code]hour[/code], [code]minute[/code], [code]second[/code]. @@ -555,8 +469,7 @@ - - + Returns the absolute directory path where user data is written ([code]user://[/code]). On Linux, this is [code]~/.local/share/godot/app_userdata/[project_name][/code], or [code]~/.local/share/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. @@ -566,127 +479,102 @@ - - + Returns the number of video drivers supported on the current platform. - - - - + + Returns the name of the video driver matching the given [code]driver[/code] index. This index is a value from [enum VideoDriver], and you can use [method get_current_video_driver] to get the current backend's index. - - + Returns the on-screen keyboard's height in pixels. Returns 0 if there is no keyboard or if it is currently hidden. - - + Returns unobscured area of the window where interactive controls should be rendered. - - - - - - - - - - + + + + + Add a new item with text "label" to global menu. Use "_dock" menu to add item to the macOS dock icon menu. [b]Note:[/b] This method is implemented on macOS. - - - - + + Add a separator between items. Separators also occupy an index. [b]Note:[/b] This method is implemented on macOS. - - - - + + Clear the global menu, in effect removing all items. [b]Note:[/b] This method is implemented on macOS. - - - - - - + + + Removes the item at index "idx" from the global menu. Note that the indexes of items after the removed item are going to be shifted by one. [b]Note:[/b] This method is implemented on macOS. - - - - + + Returns [code]true[/code] if the environment variable with the name [code]variable[/code] exists. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. - - - - + + Returns [code]true[/code] if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the [url=https://docs.godotengine.org/en/3.3/getting_started/workflow/export/feature_tags.html]Feature Tags[/url] documentation for more details. [b]Note:[/b] Tag names are case-sensitive. - - + Returns [code]true[/code] if the device has a touchscreen or emulates one. - - + Returns [code]true[/code] if the platform has a virtual keyboard, [code]false[/code] otherwise. - - + Hides the virtual keyboard if it is shown, does nothing otherwise. - - + Returns [code]true[/code] if the Godot binary used to run the project is a [i]debug[/i] export template, or when running in the editor. Returns [code]false[/code] if the Godot binary used to run the project is a [i]release[/i] export template. @@ -694,101 +582,84 @@ - - + Returns [code]true[/code] if the [b]OK[/b] button should appear on the left and [b]Cancel[/b] on the right. - - - - + + Returns [code]true[/code] if the input scancode corresponds to a Unicode character. - - + Returns [code]true[/code] if the engine was executed with [code]-v[/code] (verbose stdout). - - + If [code]true[/code], the [code]user://[/code] file system is persistent, so that its state is the same after a player quits and starts the game again. Relevant to the HTML5 platform, where this persistence may be unavailable. - - + Returns [code]true[/code] if the window should always be on top of other windows. - - + Returns [code]true[/code] if the window is currently focused. [b]Note:[/b] Only implemented on desktop platforms. On other platforms, it will always return [code]true[/code]. - - + Returns active keyboard layout index. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - + Returns the number of keyboard layouts. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + Returns the ISO-639/BCP-47 language code of the keyboard layout at position [code]index[/code]. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + Returns the localized name of the keyboard layout at position [code]index[/code]. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + Sets active keyboard layout. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + Kill (terminate) the process identified by the given process ID ([code]pid[/code]), e.g. the one returned by [method execute] in non-blocking mode. [b]Note:[/b] This method can also be used to kill processes that were not spawned by the game. @@ -796,145 +667,118 @@ - - + Moves the window to the front. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - + Returns [code]true[/code] if native video is playing. [b]Note:[/b] This method is implemented on Android and iOS. - - + Pauses native video playback. [b]Note:[/b] This method is implemented on Android and iOS. - - - - - - - - - - + + + + + Plays native video from the specified path, at the given volume and with audio and subtitle tracks. [b]Note:[/b] This method is implemented on Android and iOS, and the current Android implementation does not support the [code]volume[/code], [code]audio_track[/code] and [code]subtitle_track[/code] options. - - + Stops native video playback. [b]Note:[/b] This method is implemented on Android and iOS. - - + Resumes native video playback. [b]Note:[/b] This method is implemented on Android and iOS. - - + Initialises the singleton for the system MIDI driver. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + Shows all resources in the game. Optionally, the list can be written to a file by specifying a file path in [code]tofile[/code]. - - + Shows the list of loaded textures sorted by size in memory. - - - - + + Shows the number of resources loaded by the game of the given types. - - - - + + Shows all resources currently used by the game. - - + Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + At the moment this function is only used by [code]AudioDriverOpenSL[/code] to request permission for [code]RECORD_AUDIO[/code] on Android. - - + With this function, you can request dangerous permissions since normal permissions are automatically granted at install time in Android applications. [b]Note:[/b] This method is implemented on Android. - - - - - - + + + Sets the value of the environment variable [code]variable[/code] to [code]value[/code]. The environment variable will be set for the Godot process and any process executed with [method execute] after running [method set_environment]. The environment variable will [i]not[/i] persist to processes run after the Godot process was terminated. [b]Note:[/b] Double-check the casing of [code]variable[/code]. Environment variable names are case-sensitive on all platforms except Windows. - - - - + + Sets the game's icon using an [Image] resource. The same image is used for window caption, taskbar/dock and window selection dialog. Image is scaled as needed. @@ -942,10 +786,8 @@ - - - - + + Sets whether IME input mode should be enabled. If active IME handles key events before the application and creates an composition string and suggestion list. @@ -955,20 +797,16 @@ - - - - + + Sets position of IME suggestion list popup (in window coordinates). [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + Sets the game's icon using a multi-size platform-specific icon file ([code]*.ico[/code] on Windows and [code]*.icns[/code] on macOS). Appropriate size sub-icons are used for window caption, taskbar/dock and window selection dialog. @@ -976,38 +814,30 @@ - - - - + + Sets the name of the current thread. - - - - + + Enables backup saves if [code]enabled[/code] is [code]true[/code]. - - - - + + Sets whether the window should always be on top. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. - - - - + + Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through. Passing an empty array will disable passthrough support (all mouse events will be intercepted by the window, which is the default behavior). @@ -1026,10 +856,8 @@ - - - - + + Sets the window title to the specified string. [b]Note:[/b] This should be used sporadically. Don't set this every frame, as that will negatively affect performance on some window managers. @@ -1037,10 +865,8 @@ - - - - + + Requests the OS to open a resource with the most appropriate program. For example: - [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the user's Downloads folder. @@ -1051,12 +877,9 @@ - - - - - - + + + Shows the virtual keyboard if the platform has one. The [code]existing_text[/code] parameter is useful for implementing your own [LineEdit] or [TextEdit], as it tells the virtual keyboard what text has already been typed (the virtual keyboard uses it for auto-correct and predictions). diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 193bf28a324..b33e3ceebb6 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -26,18 +26,15 @@ - - - - + + Virtual method which can be overridden to customize the return value of [method get]. Returns the given property. Returns [code]null[/code] if the [code]property[/code] does not exist. - - + Virtual method which can be overridden to customize the return value of [method get_property_list]. Returns the object's property list as an [Array] of dictionaries. @@ -45,57 +42,45 @@ - - + Called when the object is initialized. - - - - + + Called whenever the object receives a notification, which is identified in [code]what[/code] by a constant. The base [Object] has two constants [constant NOTIFICATION_POSTINITIALIZE] and [constant NOTIFICATION_PREDELETE], but subclasses such as [Node] define a lot more notifications which are also received by this method. - - - - - - + + + Virtual method which can be overridden to customize the return value of [method set]. Sets a property. Returns [code]true[/code] if the [code]property[/code] exists. - - + Virtual method which can be overridden to customize the return value of [method to_string], and thus the object's representation where it is converted to a string, e.g. with [code]print(obj)[/code]. Returns a [String] representing the object. If not overridden, defaults to [code]"[ClassName:RID]"[/code]. - - - - - - + + + Adds a user-defined [code]signal[/code]. Arguments are optional, but can be added as an [Array] of dictionaries, each containing [code]name: String[/code] and [code]type: int[/code] (see [enum Variant.Type]) entries. - - - - + + Calls the [code]method[/code] on the object and returns the result. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblock] @@ -105,10 +90,8 @@ - - - - + + Calls the [code]method[/code] on the object during idle time. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblock] @@ -118,12 +101,9 @@ - - - - - - + + + Calls the [code]method[/code] on the object and returns the result. Contrarily to [method call], this method does not support a variable number of arguments but expects all parameters to be via a single [Array]. [codeblock] @@ -132,25 +112,18 @@ - - + Returns [code]true[/code] if the object can translate strings. See [method set_message_translation] and [method tr]. - - - - - - - - - - - - + + + + + + Connects a [code]signal[/code] to a [code]method[/code] on a [code]target[/code] object. Pass optional [code]binds[/code] to the call as an [Array] of parameters. These parameters will be passed to the method after any parameter used in the call to [method emit_signal]. Use [code]flags[/code] to set deferred or one-shot connections. See [enum ConnectFlags] constants. A [code]signal[/code] can only be connected once to a [code]method[/code]. It will throw an error if already connected, unless the signal was connected with [constant CONNECT_REFERENCE_COUNTED]. To avoid this, first, use [method is_connected] to check for existing connections. @@ -171,24 +144,18 @@ - - - - - - - - + + + + Disconnects a [code]signal[/code] from a [code]method[/code] on the given [code]target[/code]. If you try to disconnect a connection that does not exist, the method will throw an error. Use [method is_connected] to ensure that the connection exists. - - - - + + Emits the given [code]signal[/code]. The signal must exist, so it should be a built-in signal of this class or one of its parent classes, or a user-defined signal. This method supports a variable number of arguments, so parameters are passed as a comma separated list. Example: [codeblock] @@ -198,33 +165,28 @@ - - + Deletes the object from memory immediately. For [Node]s, you may want to use [method Node.queue_free] to queue the node for safe deletion at the end of the current frame. [b]Important:[/b] If you have a variable pointing to an object, it will [i]not[/i] be assigned to [code]null[/code] once the object is freed. Instead, it will point to a [i]previously freed instance[/i] and you should validate it with [method @GDScript.is_instance_valid] before attempting to call its methods or access its properties. - - - - + + Returns the [Variant] value of the given [code]property[/code]. If the [code]property[/code] doesn't exist, this will return [code]null[/code]. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). - - + Returns the object's class as a [String]. - - + Returns an [Array] of dictionaries with information about signals that are connected to the object. Each [Dictionary] contains three String entries: @@ -234,216 +196,171 @@ - - - - + + Gets the object's property indexed by the given [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Examples: [code]"position:x"[/code] or [code]"material:next_pass:blend_mode"[/code]. - - + Returns the object's unique instance ID. This ID can be saved in [EncodedObjectAsID], and can be used to retrieve the object instance with [method @GDScript.instance_from_id]. - - - - + + Returns the object's metadata entry for the given [code]name[/code]. - - + Returns the object's metadata as a [PoolStringArray]. - - + Returns the object's methods and their signatures as an [Array]. - - + Returns the object's property list as an [Array] of dictionaries. Each property's [Dictionary] contain at least [code]name: String[/code] and [code]type: int[/code] (see [enum Variant.Type]) entries. Optionally, it can also include [code]hint: int[/code] (see [enum PropertyHint]), [code]hint_string: String[/code], and [code]usage: int[/code] (see [enum PropertyUsageFlags]). - - + Returns the object's [Script] instance, or [code]null[/code] if none is assigned. - - - - + + Returns an [Array] of connections for the given [code]signal[/code]. - - + Returns the list of signals as an [Array] of dictionaries. - - - - + + Returns [code]true[/code] if a metadata entry is found with the given [code]name[/code]. - - - - + + Returns [code]true[/code] if the object contains the given [code]method[/code]. - - - - + + Returns [code]true[/code] if the given [code]signal[/code] exists. - - - - + + Returns [code]true[/code] if the given user-defined [code]signal[/code] exists. Only signals added using [method add_user_signal] are taken into account. - - + Returns [code]true[/code] if signal emission blocking is enabled. - - - - + + Returns [code]true[/code] if the object inherits from the given [code]class[/code]. - - - - - - - - + + + + Returns [code]true[/code] if a connection exists for a given [code]signal[/code], [code]target[/code], and [code]method[/code]. - - + Returns [code]true[/code] if the [method Node.queue_free] method was called for the object. - - - - - - + + + Send a given notification to the object, which will also trigger a call to the [method _notification] method of all classes that the object inherits from. If [code]reversed[/code] is [code]true[/code], [method _notification] is called first on the object's own class, and then up to its successive parent classes. If [code]reversed[/code] is [code]false[/code], [method _notification] is called first on the highest ancestor ([Object] itself), and then down to its successive inheriting classes. - - + Notify the editor that the property list has changed, so that editor plugins can take the new values into account. Does nothing on export builds. - - - - + + Removes a given entry from the object's metadata. See also [method set_meta]. - - - - - - + + + Assigns a new value to the given property. If the [code]property[/code] does not exist, nothing will happen. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). - - - - + + If set to [code]true[/code], signal emission is blocked. - - - - - - + + + Assigns a new value to the given property, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. [code]call_deferred("set", property, value)[/code]. [b]Note:[/b] In C#, the property name must be specified as snake_case if it is defined by a built-in Godot node. This doesn't apply to user-defined properties where you should use the same convention as in the C# source (typically PascalCase). - - - - - - + + + Assigns a new value to the property identified by the [NodePath]. The node path should be relative to the current object and can use the colon character ([code]:[/code]) to access nested properties. Example: [codeblock] @@ -454,49 +371,39 @@ - - - - + + Defines whether the object can translate strings (with calls to [method tr]). Enabled by default. - - - - - - + + + Adds, changes or removes a given entry in the object's metadata. Metadata are serialized and can take any [Variant] value. To remove a given entry from the object's metadata, use [method remove_meta]. Metadata is also removed if its value is set to [code]null[/code]. This means you can also use [code]set_meta("name", null)[/code] to remove metadata for [code]"name"[/code]. - - - - + + Assigns a script to the object. Each object can have a single script assigned to it, which are used to extend its functionality. If the object already had a script, the previous script instance will be freed and its variables and state will be lost. The new script's [method _init] method will be called. - - + Returns a [String] representing the object. If not overridden, defaults to [code]"[ClassName:RID]"[/code]. Override the method [method _to_string] to customize the [String] representation. - - - - + + Translates a message using translation catalogs configured in the Project Settings. Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] unchanged. See [method set_message_translation]. diff --git a/doc/classes/OptionButton.xml b/doc/classes/OptionButton.xml index af154a5e375..6d6213f99dd 100644 --- a/doc/classes/OptionButton.xml +++ b/doc/classes/OptionButton.xml @@ -11,195 +11,151 @@ - - - - - - - - + + + + Adds an item, with a [code]texture[/code] icon, text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, the item index will be used as the item's ID. New items are appended at the end. - - - - - - + + + Adds an item, with text [code]label[/code] and (optionally) [code]id[/code]. If no [code]id[/code] is passed, the item index will be used as the item's ID. New items are appended at the end. - - + Adds a separator to the list of items. Separators help to group items. Separator also takes up an index and is appended at the end. - - + Clears all the items in the [OptionButton]. - - + Returns the amount of items in the OptionButton, including separators. - - - - + + Returns the icon of the item at index [code]idx[/code]. - - - - + + Returns the ID of the item at index [code]idx[/code]. - - - - + + Returns the index of the item with the given [code]id[/code]. - - - - + + Retrieves the metadata of an item. Metadata may be any type and can be used to store extra information about an item, such as an external string ID. - - - - + + Returns the text of the item at index [code]idx[/code]. - - + Returns the [PopupMenu] contained in this button. - - + Returns the ID of the selected item, or [code]0[/code] if no item is selected. - - + Gets the metadata of the selected item. Metadata for items can be set using [method set_item_metadata]. - - - - + + Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. - - - - + + Removes the item at index [code]idx[/code]. - - - - + + Selects an item by index and makes it the current item. This will work even if the item is disabled. - - - - - - + + + Sets whether the item at index [code]idx[/code] is disabled. Disabled items are drawn differently in the dropdown and are not selectable by the user. If the current selected item is set as disabled, it will remain selected. - - - - - - + + + Sets the icon of the item at index [code]idx[/code]. - - - - - - + + + Sets the ID of the item at index [code]idx[/code]. - - - - - - + + + Sets the metadata of an item. Metadata may be of any type and can be used to store extra information about an item, such as an external string ID. - - - - - - + + + Sets the text of the item at index [code]idx[/code]. @@ -215,15 +171,13 @@ - - + Emitted when the user navigates to an item using the [code]ui_up[/code] or [code]ui_down[/code] actions. The index of the item selected is passed as argument. - - + Emitted when the current item has been changed by the user. The index of the item selected is passed as argument. diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index 268a90f03f7..97a1167603e 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -17,32 +17,24 @@ - - - - - - + + + Adds the [code]source_path[/code] file to the current PCK package at the [code]pck_path[/code] internal path (should start with [code]res://[/code]). - - - - + + Writes the files specified using all [method add_file] calls since the last flush. If [code]verbose[/code] is [code]true[/code], a list of files added will be printed to the console for easier debugging. - - - - - - + + + Creates a new PCK file with the name [code]pck_name[/code]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [code]pck_name[/code] (even though it's not required). diff --git a/doc/classes/PHashTranslation.xml b/doc/classes/PHashTranslation.xml index f206eb58a26..4f656aea847 100644 --- a/doc/classes/PHashTranslation.xml +++ b/doc/classes/PHashTranslation.xml @@ -10,10 +10,8 @@ - - - - + + Generates and sets an optimized translation from the given [Translation] resource. diff --git a/doc/classes/PackedDataContainer.xml b/doc/classes/PackedDataContainer.xml index a31b3c5c455..861e7125d87 100644 --- a/doc/classes/PackedDataContainer.xml +++ b/doc/classes/PackedDataContainer.xml @@ -8,16 +8,13 @@ - - - - + + - - + diff --git a/doc/classes/PackedDataContainerRef.xml b/doc/classes/PackedDataContainerRef.xml index 6576949cfb9..e40c1e7db39 100644 --- a/doc/classes/PackedDataContainerRef.xml +++ b/doc/classes/PackedDataContainerRef.xml @@ -9,8 +9,7 @@ - - + diff --git a/doc/classes/PackedScene.xml b/doc/classes/PackedScene.xml index 6912a57ce1a..e732b0a66b3 100644 --- a/doc/classes/PackedScene.xml +++ b/doc/classes/PackedScene.xml @@ -42,33 +42,27 @@ - - + Returns [code]true[/code] if the scene file has nodes. - - + Returns the [code]SceneState[/code] representing the scene file contents. - - - - + + Instantiates the scene's node hierarchy. Triggers child scene instantiation(s). Triggers a [constant Node.NOTIFICATION_INSTANCED] notification on the root node. - - - - + + Pack will ignore any sub-nodes not owned by given node. See [member Node.owner]. diff --git a/doc/classes/PacketPeer.xml b/doc/classes/PacketPeer.xml index b208efd58f1..43bea96ffa4 100644 --- a/doc/classes/PacketPeer.xml +++ b/doc/classes/PacketPeer.xml @@ -10,52 +10,42 @@ - - + Returns the number of packets currently available in the ring-buffer. - - + Gets a raw packet. - - + Returns the error state of the last packet received (via [method get_packet] and [method get_var]). - - - - + + Gets a Variant. If [code]allow_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. - - - - + + Sends a raw packet. - - - - - - + + + Sends a [Variant] as a packet. If [code]full_objects[/code] (or [member allow_object_decoding]) is [code]true[/code], encoding objects is allowed (and can potentially include code). diff --git a/doc/classes/PacketPeerDTLS.xml b/doc/classes/PacketPeerDTLS.xml index 862531b062e..2947e583926 100644 --- a/doc/classes/PacketPeerDTLS.xml +++ b/doc/classes/PacketPeerDTLS.xml @@ -10,37 +10,29 @@ - - - - - - - - - - + + + + + Connects a [code]peer[/code] beginning the DTLS handshake using the underlying [PacketPeerUDP] which must be connected (see [method PacketPeerUDP.connect_to_host]). If [code]validate_certs[/code] is [code]true[/code], [PacketPeerDTLS] will validate that the certificate presented by the remote peer and match it with the [code]for_hostname[/code] argument. You can specify a custom [X509Certificate] to use for validation via the [code]valid_certificate[/code] argument. - - + Disconnects this peer, terminating the DTLS session. - - + Returns the status of the connection. See [enum Status] for values. - - + Poll the connection to check for incoming packets. Call this frequently to update the status and keep the connection working. diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 8137f89e631..6b26020ac85 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -10,59 +10,48 @@ - - + Closes the UDP socket the [PacketPeerUDP] is currently listening on. - - - - - - + + + Calling this method connects this UDP peer to the given [code]host[/code]/[code]port[/code] pair. UDP is in reality connectionless, so this option only means that incoming packets from different addresses are automatically discarded, and that outgoing packets are always sent to the connected address (future calls to [method set_dest_address] are not allowed). This method does not send any data to the remote peer, to do that, use [method PacketPeer.put_var] or [method PacketPeer.put_packet] as usual. See also [UDPServer]. [b]Note:[/b] Connecting to the remote peer does not help to protect from malicious attacks like IP spoofing, etc. Think about using an encryption technique like SSL or DTLS if you feel like your application is transferring sensitive information. - - + Returns the IP of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). - - + Returns the port of the remote peer that sent the last packet(that was received with [method PacketPeer.get_packet] or [method PacketPeer.get_var]). - - + Returns [code]true[/code] if the UDP socket is open and has been connected to a remote address. See [method connect_to_host]. - - + Returns whether this [PacketPeerUDP] is listening. - - - - - - + + + Joins the multicast group specified by [code]multicast_address[/code] using the interface identified by [code]interface_name[/code]. You can join the same multicast group with multiple interfaces. Use [method IP.get_local_interfaces] to know which are available. @@ -70,25 +59,18 @@ - - - - - - + + + Removes the interface identified by [code]interface_name[/code] from the multicast group specified by [code]multicast_address[/code]. - - - - - - - - + + + + Makes this [PacketPeerUDP] listen on the [code]port[/code] binding to [code]bind_address[/code] with a buffer size [code]recv_buf_size[/code]. If [code]bind_address[/code] is set to [code]"*"[/code] (default), the peer will listen on all available addresses (both IPv4 and IPv6). @@ -97,30 +79,24 @@ - - - - + + Enable or disable sending of broadcast packets (e.g. [code]set_dest_address("255.255.255.255", 4343)[/code]. This option is disabled by default. Note: Some Android devices might require the [code]CHANGE_WIFI_MULTICAST_STATE[/code] permission and this option to be enabled to receive broadcast packets too. - - - - - - + + + Sets the destination address and port for sending packets and variables. A hostname will be resolved using DNS if needed. Note: [method set_broadcast_enabled] must be enabled before sending packets to a broadcast address (e.g. [code]255.255.255.255[/code]). - - + Waits for a packet to arrive on the listening port. See [method listen]. [b]Note:[/b] [method wait] can't be interrupted once it has been called. This can be worked around by allowing the other party to send a specific "death pill" packet like this: diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index 0bbecd15b92..c1f442b4276 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -15,35 +15,28 @@ - - + Returns the axis-aligned bounding box that contains all the particles that are active in the current frame. - - - - + + Returns the [Mesh] that is drawn at index [code]pass[/code]. - - + Restarts the particle emission, clearing existing particles. - - - - - - + + + Sets the [Mesh] that is drawn at index [code]pass[/code]. diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index cda3ef01144..e3d8f14b375 100644 --- a/doc/classes/Particles2D.xml +++ b/doc/classes/Particles2D.xml @@ -16,15 +16,13 @@ - - + Returns a rectangle containing the positions of all existing particles. - - + Restarts all the existing particles. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 0223379458f..38711b46a4f 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -12,81 +12,61 @@ - - - - + + Returns [code]true[/code] if the specified flag is enabled. - - - - + + Returns the value of the specified parameter. - - - - + + Returns the randomness ratio associated with the specified parameter. - - - - + + Returns the [Texture] used by the specified parameter. - - - - - - + + + If [code]true[/code], enables the specified flag. See [enum Flags] for options. - - - - - - + + + Sets the specified [enum Parameter]. - - - - - - + + + Sets the randomness ratio for the specified [enum Parameter]. - - - - - - + + + Sets the [Texture] for the specified [enum Parameter]. diff --git a/doc/classes/Performance.xml b/doc/classes/Performance.xml index 32c4ee0f08b..046c539e0e8 100644 --- a/doc/classes/Performance.xml +++ b/doc/classes/Performance.xml @@ -12,10 +12,8 @@ - - - - + + Returns the value of one of the available monitors. You should provide one of the [enum Monitor] constants as the argument, like this: [codeblock] diff --git a/doc/classes/PhysicalBone.xml b/doc/classes/PhysicalBone.xml index 8e1fb2ba9ab..56f6c370fcf 100644 --- a/doc/classes/PhysicalBone.xml +++ b/doc/classes/PhysicalBone.xml @@ -8,44 +8,35 @@ - - - - + + - - - - - - + + + - - + - - + - - + - - + diff --git a/doc/classes/Physics2DDirectBodyState.xml b/doc/classes/Physics2DDirectBodyState.xml index 09cb90e460e..b4819e5af2b 100644 --- a/doc/classes/Physics2DDirectBodyState.xml +++ b/doc/classes/Physics2DDirectBodyState.xml @@ -11,171 +11,134 @@ - - - - + + Adds a constant directional force without affecting rotation. - - - - - - + + + Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. - - - - + + Adds a constant rotational force. - - - - + + Applies a directional impulse without affecting rotation. - - - - - - + + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The offset uses the rotation of the global coordinate system, but is centered at the object's origin. - - - - + + Applies a rotational impulse to the body. - - - - + + Returns the collider's [RID]. - - - - + + Returns the collider's object id. - - - - + + Returns the collider object. This depends on how it was created (will return a scene node if such was used to create it). - - - - + + Returns the contact position in the collider. - - - - + + Returns the collider's shape index. - - - - + + Returns the collided shape's metadata. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. - - - - + + Returns the linear velocity vector at the collider's contact point. - - + Returns the number of contacts this body has with other bodies. [b]Note:[/b] By default, this returns 0 unless bodies are configured to monitor contacts. See [member RigidBody2D.contact_monitor]. - - - - + + Returns the local normal at the contact point. - - - - + + Returns the local position of the contact point. - - - - + + Returns the local shape index of the collision. - - + Returns the current state of the space, useful for queries. - - + Calls the built-in force integration code. diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index 8cf482fc065..9851d4b6ab9 100644 --- a/doc/classes/Physics2DDirectSpaceState.xml +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -11,10 +11,8 @@ - - - - + + Checks how far a [Shape2D] can move without colliding. All the parameters for the query, including the shape and the motion, are supplied through a [Physics2DShapeQueryParameters] object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned. @@ -22,21 +20,16 @@ - - - - - - + + + Checks the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. - - - - + + Checks the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. If it collides with more than one shape, the nearest one is selected. If the shape did not intersect anything, then an empty dictionary is returned instead. [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The returned object is a dictionary containing the following fields: @@ -50,20 +43,13 @@ - - - - - - - - - - - - - - + + + + + + + Checks whether a point is inside any solid shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. @@ -76,40 +62,25 @@ - - - - - - - - - - - - - - - - + + + + + + + + - - - - - - - - - - - - - - + + + + + + + Intersects a ray in a given space. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. @@ -124,12 +95,9 @@ - - - - - - + + + Checks the intersections of a shape, given through a [Physics2DShapeQueryParameters] object, against the space. [b]Note:[/b] This method does not take into account the [code]motion[/code] property of the object. The intersected shapes are returned in an array containing dictionaries with the following fields: diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index c474f71a850..267cd67d3ca 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -10,197 +10,145 @@ - - - - - - - - - - + + + + + Adds 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. - - - - - - + + + - - - - - - + + + Assigns the area to a descendant of [Object], so it can exist in the node tree. - - - - + + Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. - - + Creates an [Area2D]. After creating an [Area2D] with this method, assign it to a space using [method area_set_space] to use the created [Area2D] in the physics world. - - - - + + - - - - + + Gets the instance ID of the object the area is assigned to. - - - - - - + + + Returns an area parameter value. See [enum AreaParameter] for a list of available parameters. - - - - - - + + + Returns the [RID] of the nth shape of an area. - - - - + + Returns the number of shapes assigned to an area. - - - - - - + + + Returns the transform matrix of a shape within an area. - - - - + + Returns the space assigned to the area. - - - - + + Returns the space override mode for the area. - - - - + + Returns the transform matrix for an area. - - - - - - + + + Removes a shape from an area. It does not delete the shape, so it can be reassigned later. - - - - - - - - + + + + - - - - - - + + + Assigns the area to one or many physics layers. - - - - - - + + + Sets which physics layers the area will monitor. - - - - - - - - + + + + Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. @@ -211,883 +159,643 @@ - - - - - - + + + - - - - - - - - + + + + Sets the value for an area parameter. See [enum AreaParameter] for a list of available parameters. - - - - - - - - + + + + Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. - - - - - - - - + + + + Disables a given shape in an area. - - - - - - - - + + + + Sets the transform matrix for an area shape. - - - - - - + + + Assigns a space to the area. - - - - - - + + + Sets the space override mode for the area. See [enum AreaSpaceOverrideMode] for a list of available modes. - - - - - - + + + Sets the transform matrix for an area. - - - - - - + + + - - - - - - + + + Adds a body to the list of bodies exempt from collisions. - - - - - - - - + + + + Adds a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. - - - - - - - - - - + + + + + Adds 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. - - - - - - + + + - - - - - - + + + - - - - - - - - + + + + Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. - - - - - - + + + - - - - - - + + + - - - - - - + + + Assigns the area to a descendant of [Object], so it can exist in the node tree. - - - - + + Removes all shapes from a body. - - + Creates a physics body. - - - - + + - - - - + + Returns the physics layer or layers a body belongs to. - - - - + + Returns the physics layer or layers a body can collide with. - - - - + + Returns the continuous collision detection mode. - - - - + + Returns the [Physics2DDirectBodyState] of the body. - - - - + + Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. - - - - + + Returns the body mode. - - - - + + Gets the instance ID of the object the area is assigned to. - - - - - - + + + Returns the value of a body parameter. See [enum BodyParameter] for a list of available parameters. - - - - - - + + + Returns the [RID] of the nth shape of a body. - - - - + + Returns the number of shapes assigned to a body. - - - - - - + + + Returns the metadata of a shape of a body. - - - - - - + + + Returns the transform matrix of a body shape. - - - - + + Returns the [RID] of the space assigned to a body. - - - - - - + + + Returns a body state. - - - - + + Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). - - - - - - + + + Removes a body from the list of bodies exempt from collisions. - - - - - - + + + Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. - - - - - - + + + Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. - - - - - - + + + Sets the physics layer or layers a body belongs to. - - - - - - + + + Sets the physics layer or layers a body can collide with. - - - - - - + + + Sets the continuous collision detection mode using one of the [enum CCDMode] constants. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. - - - - - - - - - - + + + + + Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). - - - - - - + + + Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - - - - - - + + + Sets the body mode using one of the [enum BodyMode] constants. - - - - - - + + + Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). - - - - - - - - + + + + Sets a body parameter. See [enum BodyParameter] for a list of available parameters. - - - - - - - - + + + + Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. - - - - - - - - - - + + + + + Enables one way collision on body if [code]enable[/code] is [code]true[/code]. - - - - - - - - + + + + Disables shape in body if [code]disable[/code] is [code]true[/code]. - - - - - - - - + + + + Sets metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries. - - - - - - - - + + + + Sets the transform matrix for a body shape. - - - - - - + + + Assigns a space to the body (see [method space_create]). - - - - - - - - + + + + Sets a body state using one of the [enum BodyState] constants. Note that the method doesn't take effect immediately. The state will change on the next physics frame. - - - - - - - - - - - - - - + + + + + + + Returns [code]true[/code] if a collision would result from moving in the given direction from a given point in space. Margin increases the size of the shapes involved in the collision detection. [Physics2DTestMotionResult] can be passed to return additional information in. - - + - - + - - + - - + - - - - - - - - - - + + + + + Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. - - - - - - + + + Returns the value of a damped spring joint parameter. - - - - - - - - + + + + Sets a damped spring joint parameter. See [enum DampedStringParam] for a list of available parameters. - - - - + + Destroys any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. - - - - + + Returns information about the current state of the 2D physics engine. See [enum ProcessInfo] for a list of available states. - - - - - - - - - - - - + + + + + + Creates a groove joint between two bodies. If not specified, the bodies are assumed to be the joint itself. - - - - - - + + + Returns the value of a joint parameter. - - - - + + Returns a joint's type (see [enum JointType]). - - - - - - - - + + + + Sets a joint parameter. See [enum JointParam] for a list of available parameters. - - + - - - - - - - - + + + + Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. - - + - - + - - + - - - - + + Activates or deactivates the 2D physics engine. - - - - + + Returns the shape data. - - - - + + Returns a shape's type (see [enum ShapeType]). - - - - - - + + + Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. - - + Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space]. - - - - + + Returns the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries. - - - - - - + + + Returns the value of a space parameter. - - - - + + Returns whether the space is active. - - - - - - + + + Marks a space as active. It will not have an effect, unless it is assigned to an area or body. - - - - - - - - + + + + Sets the value for a space parameter. See [enum SpaceParameter] for a list of available parameters. diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 44990632190..fe34d74be6f 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -10,10 +10,8 @@ - - - - + + Sets the [Shape2D] that will be used for collision/intersection queries. diff --git a/doc/classes/Physics2DShapeQueryResult.xml b/doc/classes/Physics2DShapeQueryResult.xml index 680de887ab1..3f6e28d1151 100644 --- a/doc/classes/Physics2DShapeQueryResult.xml +++ b/doc/classes/Physics2DShapeQueryResult.xml @@ -10,44 +10,35 @@ - - + Returns the number of objects that intersected with the shape. - - - - + + Returns the [Object] that intersected with the shape at index [code]idx[/code]. - - - - + + Returns the instance ID of the [Object] that intersected with the shape at index [code]idx[/code]. - - - - + + Returns the child index of the object's [Shape] that intersected with the shape at index [code]idx[/code]. - - - - + + Returns the [RID] of the object that intersected with the shape at index [code]idx[/code]. diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index 2b9bdd81b9c..0ff3fcc0f94 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -11,66 +11,51 @@ - - - - + + Adds a body to the list of bodies that this body can't collide with. - - + Returns an array of nodes that were added as collision exceptions for this body. - - - - + + Returns an individual bit on the [member collision_layer]. - - - - + + Returns an individual bit on the [member collision_mask]. - - - - + + Removes a body from the list of bodies that this body can't collide with. - - - - - - + + + Sets individual bits on the [member collision_layer] bitmask. Use this if you only need to change one layer's value. - - - - - - + + + Sets individual bits on the [member collision_mask] bitmask. Use this if you only need to change one layer's value. diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index f86fa853d06..8711993ffc3 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -11,66 +11,51 @@ - - - - + + Adds a body to the list of bodies that this body can't collide with. - - + Returns an array of nodes that were added as collision exceptions for this body. - - - - + + Returns an individual bit on the [member collision_layer]. - - - - + + Returns an individual bit on the [member collision_mask]. - - - - + + Removes a body from the list of bodies that this body can't collide with. - - - - - - + + + Sets individual bits on the [member collision_layer] bitmask. Use this if you only need to change one layer's value. - - - - - - + + + Sets individual bits on the [member collision_mask] bitmask. Use this if you only need to change one layer's value. diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index 3fdf78f04bd..84311882c29 100644 --- a/doc/classes/PhysicsDirectBodyState.xml +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -10,173 +10,136 @@ - - - - + + Adds a constant directional force without affecting rotation. This is equivalent to [code]add_force(force, Vector3(0,0,0))[/code]. - - - - - - + + + Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. - - - - + + Adds a constant rotational force without affecting position. - - - - + + Applies a single directional impulse without affecting rotation. This is equivalent to [code]apply_impulse(Vector3(0, 0, 0), impulse)[/code]. - - - - - - + + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason it should only be used when simulating one-time impacts. The position uses the rotation of the global coordinate system, but is centered at the object's origin. - - - - + + Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the vector [code]j[/code] passed as parameter. - - - - + + Returns the collider's [RID]. - - - - + + Returns the collider's object id. - - - - + + Returns the collider object. - - - - + + Returns the contact position in the collider. - - - - + + Returns the collider's shape index. - - - - + + Returns the linear velocity vector at the collider's contact point. - - + Returns the number of contacts this body has with other bodies. [b]Note:[/b] By default, this returns 0 unless bodies are configured to monitor contacts. See [member RigidBody.contact_monitor]. - - - - + + Impulse created by the contact. Only implemented for Bullet physics. - - - - + + Returns the local normal at the contact point. - - - - + + Returns the local position of the contact point. - - - - + + Returns the local shape index of the collision. - - + Returns the current state of the space, useful for queries. - - + Calls the built-in force integration code. diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml index a27f4acf09f..ae20731f849 100644 --- a/doc/classes/PhysicsDirectSpaceState.xml +++ b/doc/classes/PhysicsDirectSpaceState.xml @@ -11,12 +11,9 @@ - - - - - - + + + Checks how far a [Shape] can move without colliding. All the parameters for the query, including the shape, are supplied through a [PhysicsShapeQueryParameters] object. Returns an array with the safe and unsafe proportions (between 0 and 1) of the motion. The safe proportion is the maximum fraction of the motion that can be made without a collision. The unsafe proportion is the minimum fraction of the distance that must be moved for a collision. If no collision is detected a result of [code][1.0, 1.0][/code] will be returned. @@ -24,21 +21,16 @@ - - - - - - + + + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters] object, against the space. The resulting array contains a list of points where the shape intersects another. Like with [method intersect_shape], the number of returned results can be limited to save processing time. - - - - + + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters] object, against the space. If it collides with more than one shape, the nearest one is selected. The returned object is a dictionary containing the following fields: [code]collider_id[/code]: The colliding object's ID. @@ -51,20 +43,13 @@ - - - - - - - - - - - - - - + + + + + + + Intersects a ray in a given space. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. @@ -78,12 +63,9 @@ - - - - - - + + + Checks the intersections of a shape, given through a [PhysicsShapeQueryParameters] object, against the space. The intersected shapes are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 790625b1fbe..331ea743293 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -10,188 +10,139 @@ - - - - - - - - - - + + + + + Adds 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. - - - - - - + + + Assigns the area to a descendant of [Object], so it can exist in the node tree. - - - - + + Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. - - + Creates an [Area]. - - - - + + Gets the instance ID of the object the area is assigned to. - - - - - - + + + Returns an area parameter value. A list of available parameters is on the [enum AreaParameter] constants. - - - - - - + + + Returns the [RID] of the nth shape of an area. - - - - + + Returns the number of shapes assigned to an area. - - - - - - + + + Returns the transform matrix of a shape within an area. - - - - + + Returns the space assigned to the area. - - - - + + Returns the space override mode for the area. - - - - + + Returns the transform matrix for an area. - - - - + + If [code]true[/code], area collides with rays. - - - - - - + + + Removes a shape from an area. It does not delete the shape, so it can be reassigned later. - - - - - - - - + + + + - - - - - - + + + Assigns the area to one or many physics layers. - - - - - - + + + Sets which physics layers the area will monitor. - - - - - - - - + + + + Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: [constant AREA_BODY_ADDED] or [constant AREA_BODY_REMOVED], depending on whether the object entered or exited the area. @@ -202,1060 +153,764 @@ - - - - - - + + + - - - - - - - - + + + + Sets the value for an area parameter. A list of available parameters is on the [enum AreaParameter] constants. - - - - - - + + + Sets object pickable with rays. - - - - - - - - + + + + Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. - - - - - - - - + + + + - - - - - - - - + + + + Sets the transform matrix for an area shape. - - - - - - + + + Assigns a space to the area. - - - - - - + + + Sets the space override mode for the area. The modes are described in the [enum AreaSpaceOverrideMode] constants. - - - - - - + + + Sets the transform matrix for an area. - - - - - - + + + - - - - - - + + + Adds a body to the list of bodies exempt from collisions. - - - - - - - - + + + + - - - - - - - - - - + + + + + Adds 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. - - - - - - + + + - - - - - - + + + - - - - - - - - + + + + Gives the body a push at a [code]position[/code] in the direction of the [code]impulse[/code]. - - - - - - + + + Gives the body a push to rotate it. - - - - - - + + + Assigns the area to a descendant of [Object], so it can exist in the node tree. - - - - + + Removes all shapes from a body. - - - - - - + + + Creates a physics body. The first parameter can be any value from [enum BodyMode] constants, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. - - - - + + Returns the physics layer or layers a body belongs to. - - - - + + Returns the physics layer or layers a body can collide with. - - - - - + + Returns the [PhysicsDirectBodyState] of the body. - - - - + + - - - - + + Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. - - - - + + Returns the body mode. - - - - + + Gets the instance ID of the object the area is assigned to. - - - - - - + + + Returns the value of a body parameter. A list of available parameters is on the [enum BodyParameter] constants. - - - - - - + + + Returns the [RID] of the nth shape of a body. - - - - + + Returns the number of shapes assigned to a body. - - - - - - + + + Returns the transform matrix of a body shape. - - - - + + Returns the [RID] of the space assigned to a body. - - - - - - + + + Returns a body state. - - - - - - + + + - - - - + + If [code]true[/code], the continuous collision detection mode is enabled. - - - - + + Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). - - - - + + If [code]true[/code], the body can be detected by rays. - - - - - - + + + Removes a body from the list of bodies exempt from collisions. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. - - - - - - + + + Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. - - - - - - - - + + + + - - - - - - + + + Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. - - - - - - + + + Sets the physics layer or layers a body belongs to. - - - - - - + + + Sets the physics layer or layers a body can collide with. - - - - - - + + + If [code]true[/code], the continuous collision detection mode is enabled. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. - - - - - - - - - - + + + + + Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force_integration]). - - - - - - + + + - - - - - - + + + Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. - - - - - - + + + Sets the body mode, from one of the [enum BodyMode] constants. - - - - - - + + + Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). - - - - - - - - + + + + Sets a body parameter. A list of available parameters is on the [enum BodyParameter] constants. - - - - - - + + + Sets the body pickable with rays if [code]enabled[/code] is set. - - - - - - - - + + + + Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. - - - - - - - - + + + + - - - - - - - - + + + + Sets the transform matrix for a body shape. - - - - - - + + + Assigns a space to the body (see [method space_create]). - - - - - - - - + + + + Sets a body state (see [enum BodyState] constants). - - - - - - + + + Gets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants). - - - - - - - - + + + + Sets a cone_twist_joint parameter (see [enum ConeTwistJointParam] constants). - - - - + + Destroys any of the objects created by PhysicsServer. If the [RID] passed is not one of the objects that can be created by PhysicsServer, an error will be sent to the console. - - - - - - - - + + + + Gets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants). - - - - - - - - + + + + Gets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants). - - - - - - - - - - + + + + + Sets a generic_6_DOF_joint flag (see [enum G6DOFJointAxisFlag] constants). - - - - - - - - - - + + + + + Sets a generic_6_DOF_joint parameter (see [enum G6DOFJointAxisParam] constants). - - - - + + Returns an Info defined by the [enum ProcessInfo] input given. - - - - - - + + + Gets a hinge_joint flag (see [enum HingeJointFlag] constants). - - - - - - + + + Gets a hinge_joint parameter (see [enum HingeJointParam]). - - - - - - - - + + + + Sets a hinge_joint flag (see [enum HingeJointFlag] constants). - - - - - - - - + + + + Sets a hinge_joint parameter (see [enum HingeJointParam] constants). - - - - - - - - - - + + + + + Creates a [ConeTwistJoint]. - - - - - - - - - - + + + + + Creates a [Generic6DOFJoint]. - - - - - - - - - - + + + + + Creates a [HingeJoint]. - - - - - - - - - - + + + + + Creates a [PinJoint]. - - - - - - - - - - + + + + + Creates a [SliderJoint]. - - - - + + Gets the priority value of the Joint. - - - - + + Returns the type of the Joint. - - - - - - + + + Sets the priority value of the Joint. - - - - + + Returns position of the joint in the local space of body a of the joint. - - - - + + Returns position of the joint in the local space of body b of the joint. - - - - - - + + + Gets a pin_joint parameter (see [enum PinJointParam] constants). - - - - - - + + + Sets position of the joint in the local space of body a of the joint. - - - - - - + + + Sets position of the joint in the local space of body b of the joint. - - - - - - - - + + + + Sets a pin_joint parameter (see [enum PinJointParam] constants). - - - - + + Activates or deactivates the 3D physics engine. - - - - + + Creates a shape of a type from [enum ShapeType]. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. - - - - + + Returns the shape data. - - - - + + Returns the type of shape (see [enum ShapeType] constants). - - - - - - + + + Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. - - - - - - + + + Gets a slider_joint parameter (see [enum SliderJointParam] constants). - - - - - - - - + + + + Gets a slider_joint parameter (see [enum SliderJointParam] constants). - - + Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space]. - - - - + + Returns the state of a space, a [PhysicsDirectSpaceState]. This object can be used to make collision/intersection queries. - - - - - - + + + Returns the value of a space parameter. - - - - + + Returns whether the space is active. - - - - - - + + + Marks a space as active. It will not have an effect, unless it is assigned to an area or body. - - - - - - - - + + + + Sets the value for a space parameter. A list of available parameters is on the [enum SpaceParameter] constants. diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index 634383235cf..b941e05faeb 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -10,10 +10,8 @@ - - - - + + Sets the [Shape] that will be used for collision/intersection queries. diff --git a/doc/classes/PhysicsShapeQueryResult.xml b/doc/classes/PhysicsShapeQueryResult.xml index 56f1892b9c1..19712d9d4f8 100644 --- a/doc/classes/PhysicsShapeQueryResult.xml +++ b/doc/classes/PhysicsShapeQueryResult.xml @@ -10,44 +10,35 @@ - - + Returns the number of objects that intersected with the shape. - - - - + + Returns the [Object] that intersected with the shape at index [code]idx[/code]. - - - - + + Returns the instance ID of the [Object] that intersected with the shape at index [code]idx[/code]. - - - - + + Returns the child index of the object's [Shape] that intersected with the shape at index [code]idx[/code]. - - - - + + Returns the [RID] of the object that intersected with the shape at index [code]idx[/code]. diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index b1cc8f5a2f7..eef452f87e8 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -10,21 +10,16 @@ - - - - + + Returns the value of the specified parameter. - - - - - - + + + Sets the value of the specified parameter. diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index 71047ae55b1..954ee10494a 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -11,142 +11,107 @@ - - - - - - - - - - + + + + + Creates a plane from the four parameters. The three components of the resulting plane's [member normal] are [code]a[/code], [code]b[/code] and [code]c[/code], and the plane has a distance of [code]d[/code] from the origin. - - - - - - - - + + + + Creates a plane from the three points, given in clockwise order. - - - - - - + + + Creates a plane from the normal and the plane's distance to the origin. - - + Returns the center of the plane. - - - - + + Returns the shortest distance from the plane to the position [code]point[/code]. - - + Returns the center of the plane. This method is deprecated, please use [method center] instead. - - - - - - + + + Returns [code]true[/code] if [code]point[/code] is inside the plane. Comparison uses a custom minimum [code]epsilon[/code] threshold. - - - - - - + + + Returns the intersection point of the three planes [code]b[/code], [code]c[/code] and this plane. If no intersection is found, [code]null[/code] is returned. - - - - - - + + + Returns the intersection point of a ray consisting of the position [code]from[/code] and the direction normal [code]dir[/code] with this plane. If no intersection is found, [code]null[/code] is returned. - - - - - - + + + Returns the intersection point of a segment from position [code]begin[/code] to position [code]end[/code] with this plane. If no intersection is found, [code]null[/code] is returned. - - - - + + Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. - - - - + + Returns [code]true[/code] if [code]point[/code] is located above the plane. - - + Returns a copy of the plane, normalized. - - - - + + Returns the orthogonal projection of [code]point[/code] into a point in the plane. diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 9910e6638ce..f22510df7cd 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -11,75 +11,58 @@ - - - - - - + + + Adds a bone with the specified [code]path[/code] and [code]weights[/code]. - - + Removes all bones from this [Polygon2D]. - - - - + + Removes the specified bone from this [Polygon2D]. - - + Returns the number of bones in this [Polygon2D]. - - - - + + Returns the path to the node associated with the specified bone. - - - - + + Returns the height values of the specified bone. - - - - - - + + + Sets the path to the node associated with the specified bone. - - - - - - + + + Sets the weight values for the specified bone. diff --git a/doc/classes/PolygonPathFinder.xml b/doc/classes/PolygonPathFinder.xml index abf27b31155..4ee9ed33c58 100644 --- a/doc/classes/PolygonPathFinder.xml +++ b/doc/classes/PolygonPathFinder.xml @@ -8,72 +8,53 @@ - - - - - - + + + - - + - - - - + + - - - - - - + + + - - - - + + - - - - + + - - - - - - + + + - - - - - - + + + diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 9f72802ecd4..8d72ada67d4 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -11,72 +11,59 @@ - - - - + + Constructs a new [PoolByteArray]. Optionally, you can pass in a generic [Array] that will be converted. - - + Appends an element at the end of the array (alias of [method push_back]). - - + Appends a [PoolByteArray] at the end of this array. - - - - + + Returns a new [PoolByteArray] with the data compressed. Set the compression mode using one of [enum File.CompressionMode]'s constants. - - - - - - + + + Returns a new [PoolByteArray] with the data decompressed. Set [code]buffer_size[/code] to the size of the uncompressed data. Set the compression mode using one of [enum File.CompressionMode]'s constants. - - + Returns [code]true[/code] if the array is empty. - - + Returns a copy of the array's contents as [String]. Fast alternative to [method get_string_from_utf8] if the content is ASCII-only. Unlike the UTF-8 function this function maps every byte to a character in the array. Multibyte sequences will not be interpreted correctly. For parsing user input always use [method get_string_from_utf8]. - - + Returns a copy of the array's contents as [String]. Slower than [method get_string_from_ascii] but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. - - + Returns a hexadecimal representation of this array as a [String]. [codeblock] @@ -86,12 +73,9 @@ - - - - - - + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). @@ -102,49 +86,40 @@ - - + Appends an element at the end of the array. - - + Removes an element from the array by index. - - + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - + + Changes the byte at the given index. - - + Returns the size of the array. - - - - - - + + + Returns the slice of the [PoolByteArray] between indices (inclusive) as a new [PoolByteArray]. Any negative index is considered to be from the end of the array. diff --git a/doc/classes/PoolColorArray.xml b/doc/classes/PoolColorArray.xml index bf3b0c87732..7d340ffbd2d 100644 --- a/doc/classes/PoolColorArray.xml +++ b/doc/classes/PoolColorArray.xml @@ -11,42 +11,34 @@ - - - - + + Constructs a new [PoolColorArray]. Optionally, you can pass in a generic [Array] that will be converted. - - + Appends an element at the end of the array (alias of [method push_back]). - - + Appends a [PoolColorArray] at the end of this array. - - + Returns [code]true[/code] if the array is empty. - - - - - - + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). @@ -57,38 +49,32 @@ - - + Appends a value to the array. - - + Removes an element from the array by index. - - + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - + + Changes the [Color] at the given index. - - + Returns the size of the array. diff --git a/doc/classes/PoolIntArray.xml b/doc/classes/PoolIntArray.xml index fea51bdde3a..41d8cdf8812 100644 --- a/doc/classes/PoolIntArray.xml +++ b/doc/classes/PoolIntArray.xml @@ -12,42 +12,34 @@ - - - - + + Constructs a new [PoolIntArray]. Optionally, you can pass in a generic [Array] that will be converted. - - + Appends an element at the end of the array (alias of [method push_back]). - - + Appends a [PoolIntArray] at the end of this array. - - + Returns [code]true[/code] if the array is empty. - - - - - - + + + Inserts a new int at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). @@ -58,38 +50,32 @@ - - + Appends a value to the array. - - + Removes an element from the array by index. - - + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - + + Changes the int at the given index. - - + Returns the array size. diff --git a/doc/classes/PoolRealArray.xml b/doc/classes/PoolRealArray.xml index cfc6a43baa4..0f23b5ae9bd 100644 --- a/doc/classes/PoolRealArray.xml +++ b/doc/classes/PoolRealArray.xml @@ -12,42 +12,34 @@ - - - - + + Constructs a new [PoolRealArray]. Optionally, you can pass in a generic [Array] that will be converted. - - + Appends an element at the end of the array (alias of [method push_back]). - - + Appends a [PoolRealArray] at the end of this array. - - + Returns [code]true[/code] if the array is empty. - - - - - - + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). @@ -58,38 +50,32 @@ - - + Appends an element at the end of the array. - - + Removes an element from the array by index. - - + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - + + Changes the float at the given index. - - + Returns the size of the array. diff --git a/doc/classes/PoolStringArray.xml b/doc/classes/PoolStringArray.xml index 1d85059f74c..d71df388028 100644 --- a/doc/classes/PoolStringArray.xml +++ b/doc/classes/PoolStringArray.xml @@ -12,42 +12,34 @@ - - - - + + Constructs a new [PoolStringArray]. Optionally, you can pass in a generic [Array] that will be converted. - - + Appends an element at the end of the array (alias of [method push_back]). - - + Appends a [PoolStringArray] at the end of this array. - - + Returns [code]true[/code] if the array is empty. - - - - - - + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). @@ -58,47 +50,39 @@ - - - - + + Returns a [String] with each element of the array joined with the given [code]delimiter[/code]. - - + Appends a string element at end of the array. - - + Removes an element from the array by index. - - + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - + + Changes the [String] at the given index. - - + Returns the size of the array. diff --git a/doc/classes/PoolVector2Array.xml b/doc/classes/PoolVector2Array.xml index ef0fbb509e2..da4ef7f7483 100644 --- a/doc/classes/PoolVector2Array.xml +++ b/doc/classes/PoolVector2Array.xml @@ -12,42 +12,34 @@ - - - - + + Constructs a new [PoolVector2Array]. Optionally, you can pass in a generic [Array] that will be converted. - - + Appends an element at the end of the array (alias of [method push_back]). - - + Appends a [PoolVector2Array] at the end of this array. - - + Returns [code]true[/code] if the array is empty. - - - - - - + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). @@ -58,38 +50,32 @@ - - + Inserts a [Vector2] at the end. - - + Removes an element from the array by index. - - + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - + + Changes the [Vector2] at the given index. - - + Returns the size of the array. diff --git a/doc/classes/PoolVector3Array.xml b/doc/classes/PoolVector3Array.xml index a1db77e5592..24774b6f889 100644 --- a/doc/classes/PoolVector3Array.xml +++ b/doc/classes/PoolVector3Array.xml @@ -11,42 +11,34 @@ - - - - + + Constructs a new [PoolVector3Array]. Optionally, you can pass in a generic [Array] that will be converted. - - + Appends an element at the end of the array (alias of [method push_back]). - - + Appends a [PoolVector3Array] at the end of this array. - - + Returns [code]true[/code] if the array is empty. - - - - - - + + + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). @@ -57,38 +49,32 @@ - - + Inserts a [Vector3] at the end. - - + Removes an element from the array by index. - - + Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. - - - - + + Changes the [Vector3] at the given index. - - + Returns the size of the array. diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index a5fc65af7fa..b03f3acec41 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -10,55 +10,43 @@ - - - - + + Popup (show the control in modal form). - - - - + + Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by [code]size[/code]. - - - - - - + + + Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, clamping the size to [code]size[/code], then ensuring the popup is no larger than the viewport size multiplied by [code]fallback_ratio[/code]. - - - - + + Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, ensuring the size is never smaller than [code]minsize[/code]. - - - - + + Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, scaled at a ratio of size of the screen. - - + Shrink popup to keep to the minimum size of content. diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 2d81c91181c..a91da617a0c 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -10,14 +10,10 @@ - - - - - - - - + + + + Adds a new checkable item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -25,14 +21,10 @@ - - - - - - - - + + + + Adds a new checkable item and assigns the specified [ShortCut] to it. Sets the label of the checkbox to the [ShortCut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -40,16 +32,11 @@ - - - - - - - - - - + + + + + Adds a new checkable item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -57,16 +44,11 @@ - - - - - - - - - - + + + + + Adds a new checkable item and assigns the specified [ShortCut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [ShortCut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -74,94 +56,64 @@ - - - - - - - - - - + + + + + Adds a new item with text [code]label[/code] and icon [code]texture[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. - - - - - - - - - - + + + + + Same as [method add_icon_check_item], but uses a radio check button. - - - - - - - - - - + + + + + Same as [method add_icon_check_shortcut], but uses a radio check button. - - - - - - - - - - + + + + + Adds a new item and assigns the specified [ShortCut] and icon [code]texture[/code] to it. Sets the label of the checkbox to the [ShortCut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. - - - - - - - - + + + + Adds a new item with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. - - - - - - - - - - - - + + + + + + Adds a new multistate item with text [code]label[/code]. Contrarily to normal binary items, multistate items can have more than two states, as defined by [code]max_states[/code]. Each press or activate of the item will increase the state by one. The default value is defined by [code]default_state[/code]. @@ -169,14 +121,10 @@ - - - - - - - - + + + + Adds a new radio check button with text [code]label[/code]. An [code]id[/code] can optionally be provided, as well as an accelerator ([code]accel[/code]). If no [code]id[/code] is provided, one will be created from the index. If no [code]accel[/code] is provided then the default [code]0[/code] will be assigned to it. See [method get_item_accelerator] for more info on accelerators. @@ -184,14 +132,10 @@ - - - - - - - - + + + + Adds a new radio check button and assigns a [ShortCut] to it. Sets the label of the checkbox to the [ShortCut]'s name. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. @@ -199,412 +143,313 @@ - - - - - - + + + Adds a separator between items. Separators also occupy an index, which you can set by using the [code]id[/code] parameter. A [code]label[/code] can optionally be provided, which will appear at the center of the separator. - - - - - - - - + + + + Adds a [ShortCut]. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. - - - - - - - - + + + + Adds an item that will act as a submenu of the parent [PopupMenu] node when clicked. The [code]submenu[/code] argument is the name of the child [PopupMenu] node that will be shown when the item is clicked. An [code]id[/code] can optionally be provided. If no [code]id[/code] is provided, one will be created from the index. - - + Removes all items from the [PopupMenu]. - - + Returns the index of the currently focused item. Returns [code]-1[/code] if no item is focused. - - - - + + Returns the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. - - + Returns the number of items in the [PopupMenu]. - - - - + + Returns the icon of the item at index [code]idx[/code]. - - - - + + Returns the id of the item at index [code]idx[/code]. [code]id[/code] can be manually assigned, while index can not. - - - - + + Returns the index of the item containing the specified [code]id[/code]. Index is automatically assigned to each item by the engine. Index can not be set manually. - - - - + + Returns the metadata of the specified item, which might be of any type. You can set it with [method set_item_metadata], which provides a simple way of assigning context data to items. - - - - + + Returns the [ShortCut] associated with the specified [code]idx[/code] item. - - - - + + Returns the submenu name of the item at index [code]idx[/code]. See [method add_submenu_item] for more info on how to add a submenu. - - - - + + Returns the text of the item at index [code]idx[/code]. - - - - + + Returns the tooltip associated with the specified index index [code]idx[/code]. - - + Returns [code]true[/code] if the popup will be hidden when the window loses focus or not. - - - - + + Returns [code]true[/code] if the item at index [code]idx[/code] is checkable in some way, i.e. if it has a checkbox or radio button. [b]Note:[/b] Checkable items just display a checkmark or radio button, but don't have any built-in checking behavior and must be checked/unchecked manually. - - - - + + Returns [code]true[/code] if the item at index [code]idx[/code] is checked. - - - - + + Returns [code]true[/code] if the item at index [code]idx[/code] is disabled. When it is disabled it can't be selected, or its action invoked. See [method set_item_disabled] for more info on how to disable an item. - - - - + + Returns [code]true[/code] if the item at index [code]idx[/code] has radio button-style checkability. [b]Note:[/b] This is purely cosmetic; you must add the logic for checking/unchecking items in radio groups. - - - - + + Returns [code]true[/code] if the item is a separator. If it is, it will be displayed as a line. See [method add_separator] for more info on how to add a separator. - - - - + + Returns [code]true[/code] if the specified item's shortcut is disabled. - - - - + + Removes the item at index [code]idx[/code] from the menu. [b]Note:[/b] The indices of items after the removed item will be shifted by one. - - - - + + Hides the [PopupMenu] when the window loses focus. - - - - - - + + + Sets the accelerator of the item at index [code]idx[/code]. Accelerators are special combinations of keys that activate the item, no matter which control is focused. - - - - - - + + + Sets whether the item at index [code]idx[/code] has a checkbox. If [code]false[/code], sets the type of the item to plain text. [b]Note:[/b] Checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. - - - - - - + + + Sets the type of the item at the specified index [code]idx[/code] to radio button. If [code]false[/code], sets the type of the item to plain text. - - - - - - + + + Mark the item at index [code]idx[/code] as a separator, which means that it would be displayed as a line. If [code]false[/code], sets the type of the item to plain text. - - - - - - + + + Sets the checkstate status of the item at index [code]idx[/code]. - - - - - - + + + Enables/disables the item at index [code]idx[/code]. When it is disabled, it can't be selected and its action can't be invoked. - - - - - - + + + Replaces the [Texture] icon of the specified [code]idx[/code]. - - - - - - + + + Sets the [code]id[/code] of the item at index [code]idx[/code]. - - - - - - + + + Sets the metadata of an item, which may be of any type. You can later get it with [method get_item_metadata], which provides a simple way of assigning context data to items. - - - - - - + + + Sets the state of a multistate item. See [method add_multistate_item] for details. - - - - - - - - + + + + Sets a [ShortCut] for the specified item [code]idx[/code]. - - - - - - + + + Disables the [ShortCut] of the specified index [code]idx[/code]. - - - - - - + + + Sets the submenu of the item at index [code]idx[/code]. The submenu is the name of a child [PopupMenu] node that would be shown when the item is clicked. - - - - - - + + + Sets the text of the item at index [code]idx[/code]. - - - - - - + + + Sets the [String] tooltip of the item at the specified index [code]idx[/code]. - - - - + + Toggles the check state of the item of the specified index [code]idx[/code]. - - - - + + Cycle to the next state of a multistate item. See [method add_multistate_item] for details. @@ -630,22 +475,19 @@ - - + Emitted when user navigated to an item of some [code]id[/code] using [code]ui_up[/code] or [code]ui_down[/code] action. - - + Emitted when an item of some [code]id[/code] is pressed or its accelerator is activated. - - + Emitted when an item of some [code]index[/code] is pressed or its accelerator is activated. diff --git a/doc/classes/PrimitiveMesh.xml b/doc/classes/PrimitiveMesh.xml index 2e9bcdb466e..2fa5682d5d3 100644 --- a/doc/classes/PrimitiveMesh.xml +++ b/doc/classes/PrimitiveMesh.xml @@ -10,8 +10,7 @@ - - + Returns mesh arrays used to constitute surface of [Mesh]. The result can be passed to [method ArrayMesh.add_surface_from_arrays] to create a new surface. For example: [codeblock] diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index c5fc34aad71..3d14bc1edcd 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -16,10 +16,8 @@ - - - - + + Adds a custom property info to a property. The dictionary must contain: - [code]name[/code]: [String] (the property's name) @@ -41,28 +39,22 @@ - - - - + + Clears the whole configuration (not recommended, may break things). - - - - + + Returns the order of a configuration value (influences when saved to the config file). - - - - + + Returns the value of a setting. [b]Example:[/b] @@ -72,10 +64,8 @@ - - - - + + Returns the absolute, native OS path corresponding to the localized [code]path[/code] (starting with [code]res://[/code] or [code]user://[/code]). The returned path will vary depending on the operating system and user preferences. See [url=https://docs.godotengine.org/en/3.3/tutorials/io/data_paths.html]File paths in Godot projects[/url] to see what those paths convert to. See also [method localize_path]. [b]Note:[/b] [method globalize_path] with [code]res://[/code] will not work in an exported project. Instead, prepend the executable's base directory to the path when running from an exported project: @@ -95,23 +85,17 @@ - - - - + + Returns [code]true[/code] if a configuration value is present. - - - - - - - - + + + + Loads the contents of the .pck or .zip file specified by [code]pack[/code] into the resource filesystem ([code]res://[/code]). Returns [code]true[/code] on success. [b]Note:[/b] If a file from [code]pack[/code] shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from [code]pack[/code] unless [code]replace_files[/code] is set to [code]false[/code]. @@ -119,78 +103,60 @@ - - - - + + Returns the localized path (starting with [code]res://[/code]) corresponding to the absolute, native OS [code]path[/code]. See also [method globalize_path]. - - - - + + Returns [code]true[/code] if the specified property exists and its initial value differs from the current value. - - - - + + Returns the specified property's initial value. Returns [code]null[/code] if the property does not exist. - - + Saves the configuration to the [code]project.godot[/code] file. [b]Note:[/b] This method is intended to be used by editor plugins, as modified [ProjectSettings] can't be loaded back in the running app. If you want to change project settings in exported projects, use [method save_custom] to save [code]override.cfg[/code] file. - - - - + + Saves the configuration to a custom file. The file extension must be [code].godot[/code] (to save in text-based [ConfigFile] format) or [code].binary[/code] (to save in binary format). You can also save [code]override.cfg[/code] file, which is also text, but can be used in exported projects unlike other formats. - - - - - - + + + Sets the specified property's initial value. This is the value the property reverts to. - - - - - - + + + Sets the order of a configuration value (influences when saved to the config file). - - - - - - + + + Sets the value of a setting. [b]Example:[/b] diff --git a/doc/classes/ProximityGroup.xml b/doc/classes/ProximityGroup.xml index 9fa1fe76a53..b5b2686dbef 100644 --- a/doc/classes/ProximityGroup.xml +++ b/doc/classes/ProximityGroup.xml @@ -10,12 +10,9 @@ - - - - - - + + + @@ -30,10 +27,8 @@ - - - - + + diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index 22cbe45f0a5..ecaa3732acb 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -14,168 +14,130 @@ - - - - + + Constructs a quaternion from the given [Basis]. - - - - + + Constructs a quaternion that will perform a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle). - - - - - - + + + Constructs a quaternion that will rotate around the given axis by the specified angle. The axis must be a normalized vector. - - - - - - - - - - + + + + + Constructs a quaternion defined by the given values. - - - - - - - - - - + + + + + Performs a cubic spherical interpolation between quaternions [code]pre_a[/code], this vector, [code]b[/code], and [code]post_b[/code], by the given amount [code]weight[/code]. - - - - + + Returns the dot product of two quaternions. - - + Returns Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last) corresponding to the rotation represented by the unit quaternion. Returned vector contains the rotation angles in the format (X angle, Y angle, Z angle). - - + Returns the inverse of the quaternion. - - - - + + Returns [code]true[/code] if this quaternion and [code]quat[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. - - + Returns whether the quaternion is normalized or not. - - + Returns the length of the quaternion. - - + Returns the length of the quaternion, squared. - - + Returns a copy of the quaternion, normalized to unit length. - - - - + + Sets the quaternion to a rotation which rotates around axis by the specified angle, in radians. The axis must be a normalized vector. - - + Sets the quaternion to a rotation specified by Euler angles (in the YXZ convention: when decomposing, first Z, then X, and Y last), given in the vector format as (X angle, Y angle, Z angle). - - - - - - + + + Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code]. [b]Note:[/b] Both quaternions must be normalized. - - - - - - + + + Returns the result of the spherical linear interpolation between this quaternion and [code]to[/code] by amount [code]weight[/code], but without checking if the rotation path is not bigger than 90 degrees. - - - - + + Returns a vector transformed (multiplied) by this quaternion. diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index 978ec421aa1..cd040dcfc69 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -10,17 +10,14 @@ - - - - + + Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0. - - + Returns the ID of the referenced resource. diff --git a/doc/classes/RandomNumberGenerator.xml b/doc/classes/RandomNumberGenerator.xml index 63ec2527bda..d8a7e37285e 100644 --- a/doc/classes/RandomNumberGenerator.xml +++ b/doc/classes/RandomNumberGenerator.xml @@ -20,55 +20,43 @@ - - + Generates a pseudo-random float between [code]0.0[/code] and [code]1.0[/code] (inclusive). - - - - - - + + + Generates a pseudo-random float between [code]from[/code] and [code]to[/code] (inclusive). - - - - - - + + + Generates a [url=https://en.wikipedia.org/wiki/Normal_distribution]normally-distributed[/url] pseudo-random number, using Box-Muller transform with the specified [code]mean[/code] and a standard [code]deviation[/code]. This is also called Gaussian distribution. - - + Generates a pseudo-random 32-bit unsigned integer between [code]0[/code] and [code]4294967295[/code] (inclusive). - - - - - - + + + Generates a pseudo-random 32-bit signed integer between [code]from[/code] and [code]to[/code] (inclusive). - - + Setups a time-based seed to generator. diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index 7cb7897c7f4..4958e65d068 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -10,17 +10,14 @@ - - - - + + Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. - - + Stops range from sharing its member variables with any other. @@ -65,8 +62,7 @@ - - + Emitted when [member value] changes. diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index e122ac038d1..07cc73b959c 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -16,33 +16,27 @@ - - - - + + Adds a collision exception so the ray does not report collisions with the specified node. - - - - + + Adds a collision exception so the ray does not report collisions with the specified [RID]. - - + Removes all collision exceptions for this ray. - - + Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. @@ -50,76 +44,62 @@ - - + Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). - - + Returns the shape ID of the first object that the ray intersects, or [code]0[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). - - - - + + Returns [code]true[/code] if the bit index passed is turned on. [b]Note:[/b] Bit indices range from 0-19. - - + Returns the normal of the intersecting object's shape at the collision point. - - + Returns the collision point at which the ray intersects the closest object. [b]Note:[/b] This point is in the [b]global[/b] coordinate system. - - + Returns whether any object is intersecting with the ray's vector (considering the vector length). - - - - + + Removes a collision exception so the ray does report collisions with the specified node. - - - - + + Removes a collision exception so the ray does report collisions with the specified [RID]. - - - - - - + + + Sets the bit index passed to the [code]value[/code] passed. [b]Note:[/b] Bit indexes range from 0-19. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 968b318524d..1f863cb9705 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -15,108 +15,88 @@ - - - - + + Adds a collision exception so the ray does not report collisions with the specified node. - - - - + + Adds a collision exception so the ray does not report collisions with the specified [RID]. - - + Removes all collision exceptions for this ray. - - + Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next [code]_physics_process[/code] call, for example if the ray or its parent has changed state. [b]Note:[/b] [code]enabled[/code] is not required for this to work. - - + Returns the first object that the ray intersects, or [code]null[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). - - + Returns the shape ID of the first object that the ray intersects, or [code]0[/code] if no object is intersecting the ray (i.e. [method is_colliding] returns [code]false[/code]). - - - - + + Returns an individual bit on the collision mask. - - + Returns the normal of the intersecting object's shape at the collision point. - - + Returns the collision point at which the ray intersects the closest object. [b]Note:[/b] this point is in the [b]global[/b] coordinate system. - - + Returns whether any object is intersecting with the ray's vector (considering the vector length). - - - - + + Removes a collision exception so the ray does report collisions with the specified node. - - - - + + Removes a collision exception so the ray does report collisions with the specified [RID]. - - - - - - + + + Sets or clears individual bits on the collision mask. This makes selecting the areas scanned easier. diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index d12612ea2b2..62dcab348fd 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -15,149 +15,113 @@ - - - - - - + + + Constructs a [Rect2] by position and size. - - - - - - - - - - + + + + + Constructs a [Rect2] by x, y, width, and height. - - + Returns a [Rect2] with equivalent position and area, modified so that the top-left corner is the origin and [code]width[/code] and [code]height[/code] are positive. - - - - + + Returns the intersection of this [Rect2] and b. - - - - + + Returns [code]true[/code] if this [Rect2] completely encloses another one. - - - - + + Returns this [Rect2] expanded to include a given point. - - + Returns the area of the [Rect2]. - - - - + + Returns a copy of the [Rect2] grown a given amount of units towards all the sides. - - - - - - - - - - + + + + + Returns a copy of the [Rect2] grown a given amount of units towards each direction individually. - - - - - - + + + Returns a copy of the [Rect2] grown a given amount of units towards the [enum Margin] direction. - - + Returns [code]true[/code] if the [Rect2] is flat or empty. - - - - + + Returns [code]true[/code] if the [Rect2] contains a point. - - - - - - + + + Returns [code]true[/code] if the [Rect2] overlaps with [code]b[/code] (i.e. they have at least one point in common). If [code]include_borders[/code] is [code]true[/code], they will also be considered overlapping if their borders touch, even without intersection. - - - - + + Returns [code]true[/code] if this [Rect2] and [code]rect[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. - - - - + + Returns a larger [Rect2] that contains this [Rect2] and [code]b[/code]. diff --git a/doc/classes/Reference.xml b/doc/classes/Reference.xml index f94b63fdb92..44609256ed6 100644 --- a/doc/classes/Reference.xml +++ b/doc/classes/Reference.xml @@ -14,24 +14,21 @@ - - + Initializes the internal reference counter. Use this only if you really know what you are doing. Returns whether the initialization was successful. - - + Increments the internal reference counter. Use this only if you really know what you are doing. Returns [code]true[/code] if the increment was successful, [code]false[/code] otherwise. - - + Decrements the internal reference counter. Use this only if you really know what you are doing. Returns [code]true[/code] if the decrement was successful, [code]false[/code] otherwise. diff --git a/doc/classes/RemoteTransform.xml b/doc/classes/RemoteTransform.xml index 382ca1fe85b..ba3957bfbd3 100644 --- a/doc/classes/RemoteTransform.xml +++ b/doc/classes/RemoteTransform.xml @@ -11,8 +11,7 @@ - - + [RemoteTransform] caches the remote node. It may not notice if the remote node disappears; [method force_update_cache] forces it to update the cache again. diff --git a/doc/classes/RemoteTransform2D.xml b/doc/classes/RemoteTransform2D.xml index d408266c20e..886a6214f6e 100644 --- a/doc/classes/RemoteTransform2D.xml +++ b/doc/classes/RemoteTransform2D.xml @@ -11,8 +11,7 @@ - - + [RemoteTransform2D] caches the remote node. It may not notice if the remote node disappears; [method force_update_cache] forces it to update the cache again. diff --git a/doc/classes/Resource.xml b/doc/classes/Resource.xml index 77a9f263741..e00878da31f 100644 --- a/doc/classes/Resource.xml +++ b/doc/classes/Resource.xml @@ -13,17 +13,14 @@ - - + Virtual function which can be overridden to customize the behavior value of [method setup_local_to_scene]. - - - - + + Duplicates the resource, returning a new resource. By default, sub-resources are shared between resource copies for efficiency. This can be changed by passing [code]true[/code] to the [code]subresources[/code] argument which will copy the subresources. [b]Note:[/b] If [code]subresources[/code] is [code]true[/code], this method will only perform a shallow copy. Nested resources within subresources will not be duplicated and will still be shared. @@ -31,8 +28,7 @@ - - + Emits the [signal changed] signal. If external objects which depend on this resource should be updated, this method must be called manually whenever the state of this resource has changed (such as modification of properties). @@ -44,32 +40,27 @@ - - + If [member resource_local_to_scene] is enabled and the resource was loaded from a [PackedScene] instantiation, returns the local scene where this resource's unique copy is in use. Otherwise, returns [code]null[/code]. - - + Returns 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. - - + This method is called when a resource with [member resource_local_to_scene] enabled is loaded from a [PackedScene] instantiation. Its behavior can be customized by overriding [method _setup_local_to_scene] from script. For most resources, this method performs no base logic. [ViewportTexture] performs custom logic to properly set the proxy texture and flags in the local viewport. - - - - + + Sets the path of the resource, potentially overriding an existing cache entry for this path. This differs from setting [member resource_path], as the latter would error out if another resource was already cached for the given path. diff --git a/doc/classes/ResourceFormatLoader.xml b/doc/classes/ResourceFormatLoader.xml index c30e34b05ee..1a663965196 100644 --- a/doc/classes/ResourceFormatLoader.xml +++ b/doc/classes/ResourceFormatLoader.xml @@ -12,62 +12,48 @@ - - - - - - + + + If implemented, gets the dependencies of a given resource. If [code]add_types[/code] is [code]true[/code], paths should be appended [code]::TypeName[/code], where [code]TypeName[/code] is the class name of the dependency. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. - - + Gets the list of extensions for files this loader is able to read. - - - - + + Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return [code]""[/code]. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just return [code]"Resource"[/code] for them. - - - - + + Tells which resource class this loader can load. [b]Note:[/b] Custom resource types defined by scripts aren't known by the [ClassDB], so you might just handle [code]"Resource"[/code] for them. - - - - - - + + + Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, [code]original_path[/code] will target the source file. Returns a [Resource] object on success, or an [enum Error] constant in case of failure. - - - - - - + + + If implemented, renames dependencies within the given resource and saves it. [code]renames[/code] is a dictionary [code]{ String => String }[/code] mapping old dependency paths to new paths. Returns [constant OK] on success, or an [enum Error] constant in case of failure. diff --git a/doc/classes/ResourceFormatSaver.xml b/doc/classes/ResourceFormatSaver.xml index 55c63c7ef20..4661891085c 100644 --- a/doc/classes/ResourceFormatSaver.xml +++ b/doc/classes/ResourceFormatSaver.xml @@ -11,32 +11,24 @@ - - - - + + Returns the list of extensions available for saving the resource object, provided it is recognized (see [method recognize]). - - - - + + Returns whether the given resource object can be saved by this saver. - - - - - - - - + + + + Saves the given resource object to a file at the target [code]path[/code]. [code]flags[/code] is a bitmask composed with [enum ResourceSaver.SaverFlags] constants. Returns [constant OK] on success, or an [enum Error] constant in case of failure. diff --git a/doc/classes/ResourceInteractiveLoader.xml b/doc/classes/ResourceInteractiveLoader.xml index 29ee23901ea..b1f3d4942dc 100644 --- a/doc/classes/ResourceInteractiveLoader.xml +++ b/doc/classes/ResourceInteractiveLoader.xml @@ -10,29 +10,25 @@ - - + Returns the loaded resource if the load operation completed successfully, [code]null[/code] otherwise. - - + Returns the load stage. The total amount of stages can be queried with [method get_stage_count]. - - + Returns the total amount of stages (calls to [method poll]) needed to completely load this resource. - - + Polls the loading operation, i.e. loads a data chunk up to the next stage. Returns [constant OK] if the poll is successful but the load operation has not finished yet (intermediate stage). This means [method poll] will have to be called again until the last stage is completed. @@ -41,8 +37,7 @@ - - + Polls the loading operation successively until the resource is completely loaded or a [method poll] fails. Returns [constant ERR_FILE_EOF] if the load operation has completed successfully. The loaded resource can be obtained by calling [method get_resource]. diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index a33fc71aad1..4031f842079 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -12,63 +12,48 @@ - - - - - - + + + Returns whether a recognized resource exists for the given [code]path[/code]. An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. - - - - + + Returns the dependencies for the resource at the given [code]path[/code]. - - - - + + Returns the list of recognized extensions for a resource type. - - - - + + [i]Deprecated method.[/i] Use [method has_cached] or [method exists] instead. - - - - + + Returns whether a cached resource is available for the given [code]path[/code]. Once a resource has been loaded by the engine, it is cached in memory for faster access, and future calls to the [method load] or [method load_interactive] methods will use the cached version. The cached resource can be overridden by using [method Resource.take_over_path] on a new resource for that same path. - - - - - - - - + + + + Loads a resource at the given [code]path[/code], caching the result for further access. The registered [ResourceFormatLoader]s are queried sequentially to find the first one which can handle the file's extension, and then attempt loading. If loading fails, the remaining ResourceFormatLoaders are also attempted. @@ -79,22 +64,17 @@ - - - - - - + + + Starts loading a resource interactively. The returned [ResourceInteractiveLoader] object allows to load with high granularity, calling its [method ResourceInteractiveLoader.poll] method successively to load chunks. An optional [code]type_hint[/code] can be used to further specify the [Resource] type that should be handled by the [ResourceFormatLoader]. Anything that inherits from [Resource] can be used as a type hint, for example [Image]. - - - - + + Changes the behavior on missing sub-resources. The default behavior is to abort loading. diff --git a/doc/classes/ResourcePreloader.xml b/doc/classes/ResourcePreloader.xml index a1a5e76582e..713325cc1a1 100644 --- a/doc/classes/ResourcePreloader.xml +++ b/doc/classes/ResourcePreloader.xml @@ -11,57 +11,44 @@ - - - - - - + + + Adds a resource to the preloader with the given [code]name[/code]. If a resource with the given [code]name[/code] already exists, the new resource will be renamed to "[code]name[/code] N" where N is an incrementing number starting from 2. - - - - + + Returns the resource associated to [code]name[/code]. - - + Returns the list of resources inside the preloader. - - - - + + Returns [code]true[/code] if the preloader contains a resource associated to [code]name[/code]. - - - - + + Removes the resource associated to [code]name[/code] from the preloader. - - - - - - + + + Renames a resource inside the preloader from [code]name[/code] to [code]newname[/code]. diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 1ac8a92f4cf..47a988d3623 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -11,23 +11,17 @@ - - - - + + Returns the list of extensions available for saving a resource of a given type. - - - - - - - - + + + + Saves a resource to disk to the given path, using a [ResourceFormatSaver] that recognizes the resource object. The [code]flags[/code] bitmask can be specified to customize the save behavior. diff --git a/doc/classes/RichTextEffect.xml b/doc/classes/RichTextEffect.xml index d97562e8179..46b71b9742f 100644 --- a/doc/classes/RichTextEffect.xml +++ b/doc/classes/RichTextEffect.xml @@ -18,10 +18,8 @@ - - - - + + Override this method to modify properties in [code]char_fx[/code]. The method must return [code]true[/code] if the character could be transformed successfully. If the method returns [code]false[/code], it will skip transformation to avoid displaying broken text. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 297933fe719..5b62bc73ece 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -16,268 +16,216 @@ - - - - - - - - + + + + Adds an image's opening and closing tags to the tag stack, optionally providing a [code]width[/code] and [code]height[/code] to resize the image. If [code]width[/code] or [code]height[/code] is set to 0, the image size will be adjusted in order to keep the original aspect ratio. - - - - + + Adds raw non-BBCode-parsed text to the tag stack. - - - - + + Parses [code]bbcode[/code] and adds tags to the tag stack as needed. Returns the result of the parsing, [constant OK] if successful. [b]Note:[/b] Using this method, you can't close a tag that was opened in a previous [method append_bbcode] call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the [member bbcode_text] instead of using [method append_bbcode]. - - + Clears the tag stack and sets [member bbcode_text] to an empty string. - - + Returns the height of the content. - - + Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line. - - + Returns the total number of characters from text tags. Does not include BBCodes. - - + Returns the vertical scrollbar. - - + Returns the number of visible lines. - - - - + + Installs a custom effect. [code]effect[/code] should be a valid [RichTextEffect]. - - + Adds a newline tag to the tag stack. - - - - + + The assignment version of [method append_bbcode]. Clears the tag stack and inserts the new content. Returns [constant OK] if parses [code]bbcode[/code] successfully. - - - - + + Parses BBCode parameter [code]expressions[/code] into a dictionary. - - + Terminates the current tag. Use after [code]push_*[/code] methods to close BBCodes manually. Does not need to follow [code]add_*[/code] methods. - - - - + + Adds an [code][align][/code] tag based on the given [code]align[/code] value. See [enum Align] for possible values. - - + Adds a [code][font][/code] tag with a bold font to the tag stack. This is the same as adding a [code][b][/code] tag if not currently in a [code][i][/code] tag. - - + Adds a [code][font][/code] tag with a bold italics font to the tag stack. - - + Adds a [code][cell][/code] tag to the tag stack. Must be inside a [code][table][/code] tag. See [method push_table] for details. - - - - + + Adds a [code][color][/code] tag to the tag stack. - - - - + + Adds a [code][font][/code] tag to the tag stack. Overrides default fonts for its duration. - - - - + + Adds an [code][indent][/code] tag to the tag stack. Multiplies [code]level[/code] by current [member tab_size] to determine new margin length. - - + Adds a [code][font][/code] tag with a italics font to the tag stack. This is the same as adding a [code][i][/code] tag if not currently in a [code][b][/code] tag. - - - - + + Adds a [code][list][/code] tag to the tag stack. Similar to the BBCodes [code][ol][/code] or [code][ul][/code], but supports more list types. Not fully implemented! - - - - + + Adds a [code][meta][/code] tag to the tag stack. Similar to the BBCode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types. - - + Adds a [code][font][/code] tag with a monospace font to the tag stack. - - + Adds a [code][font][/code] tag with a normal font to the tag stack. - - + Adds a [code][s][/code] tag to the tag stack. - - - - + + Adds a [code][table=columns][/code] tag to the tag stack. - - + Adds a [code][u][/code] tag to the tag stack. - - - - + + Removes a line of content from the label. Returns [code]true[/code] if the line exists. The [code]line[/code] argument is the index of the line to remove, it can take values in the interval [code][0, get_line_count() - 1][/code]. - - - - + + Scrolls the window's top line to match [code]line[/code]. - - - - - - - - + + + + Edits the selected column's expansion options. If [code]expand[/code] is [code]true[/code], the column expands in proportion to its expansion ratio versus the other columns' ratios. For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively. @@ -336,22 +284,19 @@ - - + Triggered when the user clicks on content between meta tags. If the meta is defined in text, e.g. [code][url={"data"="hi"}]hi[/url][/code], then the parameter for this signal will be a [String] type. If a particular type or an object is desired, the [method push_meta] method must be used to manually insert the data into the tag stack. - - + Triggers when the mouse exits a meta tag. - - + Triggers when the mouse enters a meta tag. diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index bc51cbd50d3..eebe9c75865 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -17,115 +17,90 @@ - - - - + + Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but the [member custom_integrator] property allows you to disable the default behavior and do fully custom force integration for a body. - - - - + + Adds a constant directional force (i.e. acceleration) without affecting rotation. This is equivalent to [code]add_force(force, Vector3(0,0,0))[/code]. - - - - - - + + + Adds a constant directional force (i.e. acceleration). The position uses the rotation of the global coordinate system, but is centered at the object's origin. - - - - + + Adds a constant rotational force (i.e. a motor) without affecting position. - - - - + + Applies a directional impulse without affecting rotation. This is equivalent to [code]apply_impulse(Vector3(0,0,0), impulse)[/code]. - - - - - - + + + Applies a positioned impulse to the body. An impulse is time independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason it should only be used when simulating one-time impacts. The position uses the rotation of the global coordinate system, but is centered at the object's origin. - - - - + + Applies a torque impulse which will be affected by the body mass and shape. This will rotate the body around the [code]impulse[/code] vector passed. - - - - + + Returns [code]true[/code] if the specified linear or rotational axis is locked. - - + Returns a list of the bodies colliding with this one. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. - - + Returns the inverse inertia tensor basis. This is used to calculate the angular acceleration resulting from a torque applied to the RigidBody. - - - - - - + + + Locks the specified linear or rotational axis. - - - - + + Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. @@ -212,30 +187,24 @@ - - + Emitted when a collision with another [PhysicsBody] or [GridMap] occurs. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody] or [GridMap]. - - + Emitted when the collision with another [PhysicsBody] or [GridMap] ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody] or [GridMap]. - - - - - - - - + + + + Emitted when one of this RigidBody's [Shape]s collides with another [PhysicsBody] or [GridMap]'s [Shape]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s. [code]body_id[/code] the [RID] of the other [PhysicsBody] or [MeshLibrary]'s [CollisionObject] used by the [PhysicsServer]. @@ -246,14 +215,10 @@ - - - - - - - - + + + + Emitted when the collision between one of this RigidBody's [Shape]s and another [PhysicsBody] or [GridMap]'s [Shape]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s. [code]body_id[/code] the [RID] of the other [PhysicsBody] or [MeshLibrary]'s [CollisionObject] used by the [PhysicsServer]. [GridMap]s are detected if the Meshes have [Shape]s. diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 89c9e10b364..ee3ce5740f3 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -17,100 +17,76 @@ - - - - + + Allows you to read and safely modify the simulation state for the object. Use this instead of [method Node._physics_process] if you need to directly change the body's [code]position[/code] or other physics properties. By default, it works in addition to the usual physics behavior, but [member custom_integrator] allows you to disable the default behavior and write custom force integration for a body. - - - - + + Adds a constant directional force without affecting rotation. - - - - - - + + + Adds a positioned force to the body. Both the force and the offset from the body origin are in global coordinates. - - - - + + Adds a constant rotational force. - - - - + + Applies a directional impulse without affecting rotation. - - - - - - + + + Applies a positioned impulse to the body. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason it should only be used when simulating one-time impacts (use the "_force" functions otherwise). The position uses the rotation of the global coordinate system, but is centered at the object's origin. - - - - + + Applies a rotational impulse to the body. - - + Returns a list of the bodies colliding with this one. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead. - - - - + + Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. - - - - - - - - - - + + + + + Returns [code]true[/code] if a collision would result from moving in the given vector. [code]margin[/code] increases the size of the shapes involved in the collision detection, and [code]result[/code] is an object of type [Physics2DTestMotionResult], which contains additional information about the collision (should there be one). @@ -188,30 +164,24 @@ - - + Emitted when a collision with another [PhysicsBody2D] or [TileMap] occurs. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - - + Emitted when the collision with another [PhysicsBody2D] or [TileMap] ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. - - - - - - - - + + + + Emitted when one of this RigidBody2D's [Shape2D]s collides with another [PhysicsBody2D] or [TileMap]'s [Shape2D]s. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_id[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [Physics2DServer]. @@ -221,14 +191,10 @@ - - - - - - - - + + + + Emitted when the collision between one of this RigidBody2D's [Shape2D]s and another [PhysicsBody2D] or [TileMap]'s [Shape2D]s ends. Requires [member contact_monitor] to be set to [code]true[/code] and [member contacts_reported] to be set high enough to detect all the collisions. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_id[/code] the [RID] of the other [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [Physics2DServer]. diff --git a/doc/classes/SceneState.xml b/doc/classes/SceneState.xml index 7c2fd4d78e1..dcca12fbd69 100644 --- a/doc/classes/SceneState.xml +++ b/doc/classes/SceneState.xml @@ -11,187 +11,146 @@ - - - - + + Returns the list of bound parameters for the signal at [code]idx[/code]. - - + Returns the number of signal connections in the scene. The [code]idx[/code] argument used to query connection metadata in other [code]get_connection_*[/code] methods in the interval [code][0, get_connection_count() - 1][/code]. - - - - + + Returns the connection flags for the signal at [code]idx[/code]. See [enum Object.ConnectFlags] constants. - - - - + + Returns the method connected to the signal at [code]idx[/code]. - - - - + + Returns the name of the signal at [code]idx[/code]. - - - - + + Returns the path to the node that owns the signal at [code]idx[/code], relative to the root node. - - - - + + Returns the path to the node that owns the method connected to the signal at [code]idx[/code], relative to the root node. - - + Returns the number of nodes in the scene. The [code]idx[/code] argument used to query node data in other [code]get_node_*[/code] methods in the interval [code][0, get_node_count() - 1][/code]. - - - - + + Returns the list of group names associated with the node at [code]idx[/code]. - - - - + + Returns the node's index, which is its position relative to its siblings. This is only relevant and saved in scenes for cases where new nodes are added to an instanced or inherited scene among siblings from the base scene. Despite the name, this index is not related to the [code]idx[/code] argument used here and in other methods. - - - - + + Returns a [PackedScene] for the node at [code]idx[/code] (i.e. the whole branch starting at this node, with its child nodes and resources), or [code]null[/code] if the node is not an instance. - - - - + + Returns the path to the represented scene file if the node at [code]idx[/code] is an [InstancePlaceholder]. - - - - + + Returns the name of the node at [code]idx[/code]. - - - - + + Returns the path to the owner of the node at [code]idx[/code], relative to the root node. - - - - - - + + + Returns the path to the node at [code]idx[/code]. If [code]for_parent[/code] is [code]true[/code], returns the path of the [code]idx[/code] node's parent instead. - - - - + + Returns the number of exported or overridden properties for the node at [code]idx[/code]. The [code]prop_idx[/code] argument used to query node property data in other [code]get_node_property_*[/code] methods in the interval [code][0, get_node_property_count() - 1][/code]. - - - - - - + + + Returns the name of the property at [code]prop_idx[/code] for the node at [code]idx[/code]. - - - - - - + + + Returns the value of the property at [code]prop_idx[/code] for the node at [code]idx[/code]. - - - - + + Returns the type of the node at [code]idx[/code]. - - - - + + Returns [code]true[/code] if the node at [code]idx[/code] is an [InstancePlaceholder]. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index e3dd50e3acf..060a82d9d94 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -14,12 +14,9 @@ - - - - - - + + + Calls [code]method[/code] on each member of the given group. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. [b]Note:[/b] [code]method[/code] may only have 5 arguments at most (7 arguments passed to this method in total). @@ -27,14 +24,10 @@ - - - - - - - - + + + + Calls [code]method[/code] on each member of the given group, respecting the given [enum GroupCallFlags]. You can pass arguments to [code]method[/code] by specifying them at the end of the method call. [b]Note:[/b] [code]method[/code] may only have 5 arguments at most (8 arguments passed to this method in total). @@ -42,10 +35,8 @@ - - - - + + Changes the running scene to the one at the given [code]path[/code], after loading it into a [PackedScene] and creating a new instance. Returns [constant OK] on success, [constant ERR_CANT_OPEN] if the [code]path[/code] cannot be loaded into a [PackedScene], or [constant ERR_CANT_CREATE] if that scene cannot be instantiated. @@ -53,10 +44,8 @@ - - - - + + Changes the running scene to a new instance of the given [PackedScene]. Returns [constant OK] on success or [constant ERR_CANT_CREATE] if the scene cannot be instantiated. @@ -64,12 +53,9 @@ - - - - - - + + + Returns a [SceneTreeTimer] which will [signal SceneTreeTimer.timeout] after the given time in seconds elapsed in this [SceneTree]. If [code]pause_mode_process[/code] is set to [code]false[/code], pausing the [SceneTree] will also pause the timer. Commonly used to create a one-shot delay timer as in the following example: @@ -83,196 +69,153 @@ - - + Returns the current frame number, i.e. the total frame count since the application started. - - + Returns the peer IDs of all connected peers of this [SceneTree]'s [member network_peer]. - - + Returns the unique peer ID of this [SceneTree]'s [member network_peer]. - - + Returns the number of nodes in this [SceneTree]. - - - - + + Returns a list of all nodes assigned to the given group. - - + Returns the sender's peer ID for the most recently received RPC call. - - - - + + Returns [code]true[/code] if the given group exists. - - + Returns [code]true[/code] if there is a [member network_peer] set. - - + Returns [code]true[/code] if the most recent [InputEvent] was marked as handled with [method set_input_as_handled]. - - + Returns [code]true[/code] if this [SceneTree]'s [member network_peer] is in server mode (listening for connections). - - - - - - + + + Sends the given notification to all members of the [code]group[/code]. - - - - - - - - + + + + Sends the given notification to all members of the [code]group[/code], respecting the given [enum GroupCallFlags]. - - - - + + Queues the given object for deletion, delaying the call to [method Object.free] to after the current frame. - - - - + + Quits the application at the end of the current iteration. A process [code]exit_code[/code] can optionally be passed as an argument. If this argument is [code]0[/code] or greater, it will override the [member OS.exit_code] defined before quitting the application. [b]Note:[/b] On iOS this method doesn't work. Instead, as recommended by the iOS Human Interface Guidelines, the user is expected to close apps via the Home button. - - + Reloads the currently active scene. Returns [constant OK] on success, [constant ERR_UNCONFIGURED] if no [member current_scene] was defined yet, [constant ERR_CANT_OPEN] if [member current_scene] cannot be loaded into a [PackedScene], or [constant ERR_CANT_CREATE] if the scene cannot be instantiated. - - - - + + If [code]true[/code], the application automatically accepts quitting. Enabled by default. For mobile platforms, see [method set_quit_on_go_back]. - - - - - - - - + + + + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group. - - - - - - - - - - + + + + + Sets the given [code]property[/code] to [code]value[/code] on all members of the given group, respecting the given [enum GroupCallFlags]. - - + Marks the most recent [InputEvent] as handled. - - - - + + If [code]true[/code], the application quits automatically on going back (e.g. on Android). Enabled by default. To handle 'Go Back' button when this option is disabled, use [constant MainLoop.NOTIFICATION_WM_GO_BACK_REQUEST]. - - - - - - - - - - + + + + + Configures screen stretching to the given [enum StretchMode], [enum StretchAspect], minimum size and [code]shrink[/code] ratio. @@ -328,19 +271,15 @@ - - - - + + Emitted when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. - - - - + + Emitted whenever global menu item is clicked. @@ -351,43 +290,37 @@ - - + Emitted whenever this [SceneTree]'s [member network_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). - - + Emitted whenever this [SceneTree]'s [member network_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. - - + Emitted whenever a node is added to the [SceneTree]. - - + Emitted when a node's configuration changed. Only emitted in [code]tool[/code] mode. - - + Emitted whenever a node is removed from the [SceneTree]. - - + Emitted whenever a node is renamed. diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 79060afc8d5..a5c31f23a11 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -12,100 +12,83 @@ - - + Returns [code]true[/code] if the script can be instanced. - - + Returns the script directly inherited by this script. - - + Returns the script's base type. - - - - + + Returns the default value of the specified property. - - + Returns a dictionary containing constant names and their values. - - + Returns the list of methods in this [Script]. - - + Returns the list of properties in this [Script]. - - + Returns the list of user signals defined in this [Script]. - - - - + + Returns [code]true[/code] if the script, or a base class, defines a signal with the given name. - - + Returns [code]true[/code] if the script contains non-empty source code. - - - - + + Returns [code]true[/code] if [code]base_object[/code] is an instance of this script. - - + Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor. - - - - + + Reloads the script's class implementation. Returns an error code. diff --git a/doc/classes/ScriptCreateDialog.xml b/doc/classes/ScriptCreateDialog.xml index 97e37669c3e..ffb0be52108 100644 --- a/doc/classes/ScriptCreateDialog.xml +++ b/doc/classes/ScriptCreateDialog.xml @@ -16,16 +16,11 @@ - - - - - - - - - - + + + + + Prefills required fields to configure the ScriptCreateDialog for use. @@ -40,8 +35,7 @@ - - + Emitted when the user clicks the OK button. diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 4660bf28526..b0f20e64dc5 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -10,69 +10,51 @@ - - - - - - - - + + + + - - - - - - - - + + + + - - + Returns a [Script] that is currently active in editor. - - - - - - + + + - - + Returns an array with all [Script] objects which are currently open in editor. - - - - + + Goes to the specified line in the current script. - - - - - - + + + Opens the script create dialog. The script will extend [code]base_name[/code]. The file extension can be omitted from [code]base_path[/code]. It will be added based on the selected scripting language. @@ -80,15 +62,13 @@ - - + Emitted when user changed active script. Argument is a freshly activated [Script]. - - + Emitted when editor is about to close the active script. Argument is a [Script] that is going to be closed. diff --git a/doc/classes/ScrollContainer.xml b/doc/classes/ScrollContainer.xml index 3ed8d206bc8..ac3aa8dd989 100644 --- a/doc/classes/ScrollContainer.xml +++ b/doc/classes/ScrollContainer.xml @@ -10,15 +10,13 @@ - - + Returns the horizontal scrollbar [HScrollBar] of this [ScrollContainer]. - - + Returns the vertical scrollbar [VScrollBar] of this [ScrollContainer]. diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml index e438f34f714..887c50f70f3 100644 --- a/doc/classes/Semaphore.xml +++ b/doc/classes/Semaphore.xml @@ -11,15 +11,13 @@ - - + Lowers the [Semaphore], allowing one more thread in. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. - - + Tries to wait for the [Semaphore], if its value is zero, blocks until non-zero. Returns [constant OK] on success, [constant ERR_BUSY] otherwise. diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index b136e08d0ca..0973dc31788 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -12,39 +12,31 @@ - - - - + + Returns the texture that is set as default for the specified parameter. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. - - + Returns the shader mode for the shader, either [constant MODE_CANVAS_ITEM], [constant MODE_SPATIAL] or [constant MODE_PARTICLES]. - - - - + + Returns [code]true[/code] if the shader has this param defined as a uniform in its code. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. - - - - - - + + + Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the [ShaderMaterial]. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 0bfd775c2c1..0044b18d5f2 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -12,39 +12,30 @@ - - - - + + Returns the current value set for this material of a uniform in the shader. - - - - + + Returns [code]true[/code] if the property identified by [code]name[/code] can be reverted to a default value. - - - - + + Returns the default value of the material property with given [code]name[/code]. - - - - - - + + + Changes the value set for this material of a uniform in the shader. [b]Note:[/b] [code]param[/code] must match the name of the uniform in the code exactly. diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml index 66ce155d52f..926fbdee380 100644 --- a/doc/classes/Shape.xml +++ b/doc/classes/Shape.xml @@ -11,8 +11,7 @@ - - + Returns the [ArrayMesh] used to draw the debug collision for this [Shape]. diff --git a/doc/classes/Shape2D.xml b/doc/classes/Shape2D.xml index 53480131e0f..55cfd378cd7 100644 --- a/doc/classes/Shape2D.xml +++ b/doc/classes/Shape2D.xml @@ -11,76 +11,53 @@ - - - - - - - - + + + + Returns [code]true[/code] if this shape is colliding with another. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). - - - - - - - - + + + + Returns a list of the points where this shape touches another. If there are no collisions the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]). - - - - - - - - - - - - + + + + + + Returns whether this shape would collide with another, if a given movement was applied. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). - - - - - - - - - - - - + + + + + + Returns a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions the list is empty. This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). - - - - - - + + + Draws a solid shape onto a [CanvasItem] with the [VisualServer] API filled with the specified [code]color[/code]. The exact drawing method is specific for each shape and cannot be configured. diff --git a/doc/classes/ShortCut.xml b/doc/classes/ShortCut.xml index fc3afaa99b4..c64ccd0a7ad 100644 --- a/doc/classes/ShortCut.xml +++ b/doc/classes/ShortCut.xml @@ -11,24 +11,20 @@ - - + Returns the shortcut's [InputEvent] as a [String]. - - - - + + Returns [code]true[/code] if the shortcut's [InputEvent] equals [code]event[/code]. - - + If [code]true[/code], this shortcut is valid. diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index 10075de7c58..fe8fb439075 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -14,263 +14,200 @@ - - - - + + Adds a bone, with name [code]name[/code]. [method get_bone_count] will become the bone index. - - - - - - + + + [i]Deprecated soon.[/i] - - + Clear all the bones in this skeleton. - - + - - - - + + Returns the bone index that matches [code]name[/code] as its name. - - + Returns the amount of bones in the skeleton. - - - - + + Returns the custom pose of the specified bone. Custom pose is applied on top of the rest pose. - - - - + + Returns the overall transform of the specified bone, with respect to the skeleton. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. - - - - + + Returns the overall transform of the specified bone, with respect to the skeleton, but without any global pose overrides. Being relative to the skeleton frame, this is not the actual "global" transform of the bone. - - - - + + Returns the name of the bone at index [code]index[/code]. - - - - + + Returns the bone index which is the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent. [b]Note:[/b] The parent bone returned will always be less than [code]bone_idx[/code]. - - - - + + Returns the pose transform of the specified bone. Pose is applied on top of the custom pose, which is applied on top the rest pose. - - - - + + Returns the rest transform for a bone [code]bone_idx[/code]. - - - - + + [i]Deprecated soon.[/i] - - - - + + - - + - - - - + + - - - - + + - - - - + + - - + - - - - + + - - - - - - + + + - - - - - - + + + - - - - - - - - - - + + + + + - - - - - - + + + Sets the bone index [code]parent_idx[/code] as the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent. [b]Note:[/b] [code]parent_idx[/code] must be less than [code]bone_idx[/code]. - - - - - - + + + Sets the pose transform for bone [code]bone_idx[/code]. - - - - - - + + + Sets the rest transform for bone [code]bone_idx[/code]. - - - - - - + + + [i]Deprecated soon.[/i] - - - - + + diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml index b78c88157fa..b3ac459d63e 100644 --- a/doc/classes/Skeleton2D.xml +++ b/doc/classes/Skeleton2D.xml @@ -11,24 +11,20 @@ - - - - + + Returns a [Bone2D] from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter [code]idx[/code]. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling. - - + Returns the number of [Bone2D] nodes in the node hierarchy parented by Skeleton2D. - - + Returns the [RID] of a Skeleton2D instance. diff --git a/doc/classes/SkeletonIK.xml b/doc/classes/SkeletonIK.xml index 7935675273f..e70644e7fb5 100644 --- a/doc/classes/SkeletonIK.xml +++ b/doc/classes/SkeletonIK.xml @@ -30,31 +30,26 @@ - - + Returns the parent [Skeleton] Node that was present when SkeletonIK entered the [SceneTree]. Returns null if the parent node was not a [Skeleton] Node when SkeletonIK entered the [SceneTree]. - - + Returns [code]true[/code] if SkeletonIK is applying IK effects on continues frames to the [Skeleton] bones. Returns [code]false[/code] if SkeletonIK is stopped or [method start] was used with the [code]one_time[/code] parameter set to [code]true[/code]. - - - - + + Starts applying IK effects on each frame to the [Skeleton] bones but will only take effect starting on the next frame. If [code]one_time[/code] is [code]true[/code], this will take effect immediately but also reset on the next frame. - - + Stops applying IK effects on each frame to the [Skeleton] bones and also calls [method Skeleton.clear_bones_global_pose_override] to remove existing overrides on all bones. diff --git a/doc/classes/Skin.xml b/doc/classes/Skin.xml index cedb01446bf..eb073e761b3 100644 --- a/doc/classes/Skin.xml +++ b/doc/classes/Skin.xml @@ -8,86 +8,64 @@ - - - - - - + + + - - + - - - - + + - - + - - - - + + - - - - + + - - - - - - + + + - - - - + + - - - - - - + + + - - - - - - + + + diff --git a/doc/classes/SkinReference.xml b/doc/classes/SkinReference.xml index 2a02ee34fe8..f0f42a603c3 100644 --- a/doc/classes/SkinReference.xml +++ b/doc/classes/SkinReference.xml @@ -8,14 +8,12 @@ - - + - - + diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index e2cc0b06a32..3891a895557 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -10,20 +10,15 @@ - - - - + + - - - - - - + + + diff --git a/doc/classes/SoftBody.xml b/doc/classes/SoftBody.xml index f09e6bd1552..b9f9fd9912c 100644 --- a/doc/classes/SoftBody.xml +++ b/doc/classes/SoftBody.xml @@ -11,66 +11,51 @@ - - - - + + Adds a body to the list of bodies that this body can't collide with. - - + Returns an array of nodes that were added as collision exceptions for this body. - - - - + + Returns an individual bit on the collision mask. - - - - + + Returns an individual bit on the collision mask. - - - - + + Removes a body from the list of bodies that this body can't collide with. - - - - - - + + + Sets individual bits on the layer mask. Use this if you only need to change one layer's value. - - - - - - + + + Sets individual bits on the collision mask. Use this if you only need to change one layer's value. diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 0d6e23ac433..25be5bb86e8 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -14,104 +14,85 @@ - - + Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations. - - + Returns the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. - - + Returns the current [World] resource this [Spatial] node is registered to. - - - - - - + + + Rotates the global (world) transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in global coordinate system. - - - - + + Scales the global (world) transformation by the given [Vector3] scale factors. - - - - + + Moves the global (world) transformation by [Vector3] offset. The offset is in global coordinate system. - - + Disables rendering of this node. Changes [member visible] to [code]false[/code]. - - + Returns whether node notifies about its local transformation changes. [Spatial] will not propagate this by default. - - + Returns whether this node uses a scale of [code](1, 1, 1)[/code] or its local transformation scale. - - + Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations. - - + Returns whether the node notifies about its global and local transformation changes. [Spatial] will not propagate this by default. - - + Returns [code]true[/code] if the node is present in the [SceneTree], its [member visible] property is [code]true[/code] and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree. - - - - - - + + + Rotates itself so that the local -Z axis points towards the [code]target[/code] position. The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors. @@ -119,182 +100,142 @@ - - - - - - - - + + + + Moves the node to the specified [code]position[/code], and then rotates itself to point toward the [code]target[/code] as per [method look_at]. Operations take place in global space. - - + Resets this node's transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node's [Transform]. - - - - - - + + + Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. - - - - - - + + + Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system. - - - - + + Rotates the local transformation around the X axis by angle in radians. - - - - + + Rotates the local transformation around the Y axis by angle in radians. - - - - + + Rotates the local transformation around the Z axis by angle in radians. - - - - + + Scales the local transformation by given 3D scale factors in object-local coordinate system. - - - - + + Makes the node ignore its parents transformations. Node transformations are only in global space. - - - - + + Sets whether the node uses a scale of [code](1, 1, 1)[/code] or its local transformation scale. Changes to the local transformation scale are preserved. - - + Reset all transformations for this node (sets its [Transform] to the identity matrix). - - - - + + Sets whether the node ignores notification that its transformation (global or local) changed. - - - - + + Sets whether the node notifies about its local transformation changes. [Spatial] will not propagate this by default. - - - - + + Sets whether the node notifies about its global and local transformation changes. [Spatial] will not propagate this by default, unless it is in the editor context and it has a valid gizmo. - - + Enables rendering of this node. Changes [member visible] to [code]true[/code]. - - - - + + Transforms [code]local_point[/code] from this node's local space to world space. - - - - + + Transforms [code]global_point[/code] from world space to this node's local space. - - - - + + Changes the node's position by the given offset [Vector3]. Note that the translation [code]offset[/code] is affected by the node's scale, so if scaled by e.g. [code](10, 1, 1)[/code], a translation by an offset of [code](2, 0, 0)[/code] would actually add 20 ([code]2 * 10[/code]) to the X coordinate. - - - - + + Changes the node's position by the given offset [Vector3] in local space. - - + Updates the [SpatialGizmo] of this node. diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 777420832f2..63299c1325b 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -11,61 +11,46 @@ - - - - + + Returns [code]true[/code], if the specified [enum Feature] is enabled. - - - - + + Returns [code]true[/code], if the specified flag is enabled. See [enum Flags] enumerator for options. - - - - + + Returns the [Texture] associated with the specified [enum TextureParam]. - - - - - - + + + If [code]true[/code], enables the specified [enum Feature]. Many features that are available in [SpatialMaterial]s need to be enabled before use. This way the cost for using the feature is only incurred when specified. Features can also be enabled by setting the corresponding member to [code]true[/code]. - - - - - - + + + If [code]true[/code], enables the specified flag. Flags are optional behaviour that can be turned on and off. Only one flag can be enabled at a time with this function, the flag enumerators cannot be bit-masked together to enable or disable multiple flags at once. Flags can also be enabled by setting the corresponding member to [code]true[/code]. See [enum Flags] enumerator for options. - - - - - - + + + Sets the [Texture] to be used by the specified [enum TextureParam]. This function is called when setting members ending in [code]*_texture[/code]. diff --git a/doc/classes/SpatialVelocityTracker.xml b/doc/classes/SpatialVelocityTracker.xml index 9938d676b3f..707b8aa020e 100644 --- a/doc/classes/SpatialVelocityTracker.xml +++ b/doc/classes/SpatialVelocityTracker.xml @@ -8,24 +8,19 @@ - - + - - - - + + - - - - + + diff --git a/doc/classes/SpinBox.xml b/doc/classes/SpinBox.xml index e9de5c41841..1cc4f4942d9 100644 --- a/doc/classes/SpinBox.xml +++ b/doc/classes/SpinBox.xml @@ -21,15 +21,13 @@ - - + Applies the current value of this [SpinBox]. - - + Returns the [LineEdit] instance from this [SpinBox]. You can use it to access properties and methods of [LineEdit]. diff --git a/doc/classes/SplitContainer.xml b/doc/classes/SplitContainer.xml index 8cda52440f5..649f00e1eea 100644 --- a/doc/classes/SplitContainer.xml +++ b/doc/classes/SplitContainer.xml @@ -10,8 +10,7 @@ - - + Clamps the [member split_offset] value to not go outside the currently possible minimal and maximum values. @@ -30,8 +29,7 @@ - - + Emitted when the dragger is dragged by user. diff --git a/doc/classes/SpringArm.xml b/doc/classes/SpringArm.xml index 574bcf31987..6714db78e71 100644 --- a/doc/classes/SpringArm.xml +++ b/doc/classes/SpringArm.xml @@ -13,33 +13,27 @@ - - - - + + Adds the [PhysicsBody] object with the given [RID] to the list of [PhysicsBody] objects excluded from the collision check. - - + Clears the list of [PhysicsBody] objects excluded from the collision check. - - + Returns the spring arm's current length. - - - - + + Removes the given [RID] from the list of [PhysicsBody] objects excluded from the collision check. diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index ccdb46409a6..c186595bf11 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -11,8 +11,7 @@ - - + Returns a [Rect2] representing the Sprite's boundary in local coordinates. Can be used to detect if the Sprite was clicked. Example: [codeblock] @@ -24,10 +23,8 @@ - - - - + + Returns [code]true[/code], if the pixel at the given position is opaque and [code]false[/code] in other case. [b]Note:[/b] It also returns [code]false[/code], if the sprite's texture is [code]null[/code] or if the given position is invalid. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 62b6e0293bb..982bc90bb89 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -10,34 +10,27 @@ - - + - - - - + + Returns the value of the specified flag. - - + Returns the rectangle representing this sprite. - - - - - - + + + If [code]true[/code], the specified flag will be enabled. diff --git a/doc/classes/SpriteFrames.xml b/doc/classes/SpriteFrames.xml index 374233ca982..c6728437062 100644 --- a/doc/classes/SpriteFrames.xml +++ b/doc/classes/SpriteFrames.xml @@ -11,159 +11,120 @@ - - - - + + Adds a new animation to the library. - - - - - - - - + + + + Adds a frame to the given animation. - - - - + + Removes all frames from the given animation. - - + Removes all animations. A "default" animation will be created. - - - - + + Returns [code]true[/code] if the given animation is configured to loop when it finishes playing. Otherwise, returns [code]false[/code]. - - + Returns an array containing the names associated to each animation. Values are placed in alphabetical order. - - - - + + The animation's speed in frames per second. - - - - - - + + + Returns the animation's selected frame. - - - - + + Returns the number of frames in the animation. - - - - + + If [code]true[/code], the named animation exists. - - - - + + Removes the given animation. - - - - - - + + + Removes the animation's selected frame. - - - - - - + + + Changes the animation's name to [code]newname[/code]. - - - - - - + + + If [code]true[/code], the animation will loop. - - - - - - + + + The animation's speed in frames per second. - - - - - - - - + + + + Sets the texture of the given frame. diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index a77ecd520fb..d6ad32ff797 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -10,205 +10,166 @@ - - + Gets a signed 16-bit value from the stream. - - + Gets a signed 32-bit value from the stream. - - + Gets a signed 64-bit value from the stream. - - + Gets a signed byte from the stream. - - + Returns the amount of bytes this [StreamPeer] has available. - - - - + + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the [code]bytes[/code] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array. - - + Gets a double-precision float from the stream. - - + Gets a single-precision float from the stream. - - - - + + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array. - - - - + + Gets a string with byte-length [code]bytes[/code] from the stream. If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_string]. - - + Gets an unsigned 16-bit value from the stream. - - + Gets an unsigned 32-bit value from the stream. - - + Gets an unsigned 64-bit value from the stream. - - + Gets an unsigned byte from the stream. - - - - + + Gets an UTF-8 string with byte-length [code]bytes[/code] from the stream (this decodes the string sent as UTF-8). If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string]. - - - - + + Gets a Variant from the stream. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. - - - - + + Puts a signed 16-bit value into the stream. - - - - + + Puts a signed 32-bit value into the stream. - - - - + + Puts a signed 64-bit value into the stream. - - - - + + Puts a signed byte into the stream. - - - - + + Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an [enum @GlobalScope.Error] code. - - - - + + Puts a double-precision float into the stream. - - - - + + Puts a single-precision float into the stream. - - - - + + Sends 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 [enum @GlobalScope.Error] code and an integer, describing how much data was actually sent. - - - - + + Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. Note: To put an ASCII string without prepending its size, you can use [method put_data]: @@ -218,46 +179,36 @@ - - - - + + Puts an unsigned 16-bit value into the stream. - - - - + + Puts an unsigned 32-bit value into the stream. - - - - + + Puts an unsigned 64-bit value into the stream. - - - - + + Puts an unsigned byte into the stream. - - - - + + Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. Note: To put an UTF-8 string without prepending its size, you can use [method put_data]: @@ -267,12 +218,9 @@ - - - - - - + + + Puts a Variant into the stream. If [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). diff --git a/doc/classes/StreamPeerBuffer.xml b/doc/classes/StreamPeerBuffer.xml index 17c5d3053c7..39ebc420b95 100644 --- a/doc/classes/StreamPeerBuffer.xml +++ b/doc/classes/StreamPeerBuffer.xml @@ -8,42 +8,34 @@ - - + - - + - - + - - + - - - - + + - - - - + + diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index c62c526d78c..1f55df7c2f3 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -11,53 +11,40 @@ - - - - - - - - - - + + + + + Accepts a peer connection as a server using the given [code]private_key[/code] and providing the given [code]certificate[/code] to the client. You can pass the optional [code]chain[/code] parameter to provide additional CA chain information along with the certificate. - - - - - - - - - - + + + + + Connects to a peer using an underlying [StreamPeer] [code]stream[/code]. If [code]validate_certs[/code] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [code]for_hostname[/code]. [b]Note:[/b] Specifying a custom [code]valid_certificate[/code] is not supported in HTML5 exports due to browsers restrictions. - - + Disconnects from host. - - + Returns the status of the connection. See [enum Status] for values. - - + Poll the connection to check for incoming bytes. Call this right before [method StreamPeer.get_available_bytes] for it to work properly. diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index eb4048a6c55..d468f4e8405 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -10,56 +10,46 @@ - - - - - - + + + Connects to the specified [code]host:port[/code] pair. A hostname will be resolved if valid. Returns [constant OK] on success or [constant FAILED] on failure. - - + Disconnects from host. - - + Returns the IP of this peer. - - + Returns the port of this peer. - - + Returns the status of the connection, see [enum Status]. - - + Returns [code]true[/code] if this peer is currently connected or is connecting to a host, [code]false[/code] otherwise. - - - - + + If [code]enabled[/code] is [code]true[/code], packets will be sent immediately. If [code]enabled[/code] is [code]false[/code] (the default), packet transfers will be delayed and combined using [url=https://en.wikipedia.org/wiki/Nagle%27s_algorithm]Nagle's algorithm[/url]. [b]Note:[/b] It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth. diff --git a/doc/classes/StreamTexture.xml b/doc/classes/StreamTexture.xml index 13883651f48..c300ccd11f2 100644 --- a/doc/classes/StreamTexture.xml +++ b/doc/classes/StreamTexture.xml @@ -10,10 +10,8 @@ - - - - + + Loads the texture from the given path. diff --git a/doc/classes/String.xml b/doc/classes/String.xml index fb8649d066a..9984259f791 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -11,264 +11,208 @@ - - - - + + Constructs a new String from the given [bool]. - - - - + + Constructs a new String from the given [int]. - - - - + + Constructs a new String from the given [float]. - - - - + + Constructs a new String from the given [Vector2]. - - - - + + Constructs a new String from the given [Rect2]. - - - - + + Constructs a new String from the given [Vector3]. - - - - + + Constructs a new String from the given [Transform2D]. - - - - + + Constructs a new String from the given [Plane]. - - - - + + Constructs a new String from the given [Quat]. - - - - + + Constructs a new String from the given [AABB]. - - - - + + Constructs a new String from the given [Basis]. - - - - + + Constructs a new String from the given [Transform]. - - - - + + Constructs a new String from the given [Color]. - - - - + + Constructs a new String from the given [NodePath]. - - - - + + Constructs a new String from the given [RID]. - - - - + + Constructs a new String from the given [Dictionary]. - - - - + + Constructs a new String from the given [Array]. - - - - + + Constructs a new String from the given [PoolByteArray]. - - - - + + Constructs a new String from the given [PoolIntArray]. - - - - + + Constructs a new String from the given [PoolRealArray]. - - - - + + Constructs a new String from the given [PoolStringArray]. - - - - + + Constructs a new String from the given [PoolVector2Array]. - - - - + + Constructs a new String from the given [PoolVector3Array]. - - - - + + Constructs a new String from the given [PoolColorArray]. - - - - + + Returns [code]true[/code] if the string begins with the given string. - - + Returns the bigrams (pairs of consecutive letters) of this string. - - + Returns a copy of the string with special characters escaped using the C language standard. - - + Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are [code]\'[/code], [code]\"[/code], [code]\?[/code], [code]\\[/code], [code]\a[/code], [code]\b[/code], [code]\f[/code], [code]\n[/code], [code]\r[/code], [code]\t[/code], [code]\v[/code]. [b]Note:[/b] Unlike the GDScript parser, this method doesn't support the [code]\uXXXX[/code] escape sequence. - - + Changes the case of some letters. Replaces underscores with spaces, adds spaces before in-word uppercase characters, converts all letters to lowercase, then capitalizes the first letter and every letter following a space character. For [code]capitalize camelCase mixed_with_underscores[/code], it will return [code]Capitalize Camel Case Mixed With Underscores[/code]. - - - - + + Performs a case-sensitive comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/code] of each string, which roughly matches the alphabetical order. [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. @@ -277,70 +221,53 @@ - - - - - - - - + + + + Returns the number of occurrences of substring [code]what[/code] between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. - - - - - - - - + + + + Returns the number of occurrences of substring [code]what[/code] (ignoring case) between [code]from[/code] and [code]to[/code] positions. If [code]from[/code] and [code]to[/code] equals 0 the whole string will be used. If only [code]to[/code] equals 0 the remained substring will be used. - - + Returns a copy of the string with indentation (leading tabs and spaces) removed. - - + Returns [code]true[/code] if the length of the string equals [code]0[/code]. - - - - + + Returns [code]true[/code] if the string ends with the given string. - - - - + + Erases [code]chars[/code] characters from the string starting from [code]position[/code]. - - - - - - + + + Finds the first occurrence of a substring. Returns the starting position of the substring or [code]-1[/code] if not found. Optionally, the initial search index can be passed. [b]Note:[/b] If you just want to know whether a string contains a substring, use the [code]in[/code] operator as follows: @@ -352,74 +279,60 @@ - - - - + + Finds the last occurrence of a substring. Returns the starting position of the substring or [code]-1[/code] if not found. - - - - - - + + + Finds the first occurrence of a substring, ignoring case. Returns the starting position of the substring or [code]-1[/code] if not found. Optionally, the initial search index can be passed. - - - - - - + + + Formats the string by replacing all occurrences of [code]placeholder[/code] with [code]values[/code]. - - + If the string is a valid file path, returns the base directory name. - - + If the string is a valid file path, returns the full file path without the extension. - - + If the string is a valid file path, returns the extension. - - + If the string is a valid file path, returns the filename. - - + Hashes the string and returns a 32-bit integer. - - + Converts a string containing a hexadecimal number into an integer. Hexadecimal strings are expected to be prefixed with "[code]0x[/code]" otherwise [code]0[/code] is returned. [codeblock] @@ -428,8 +341,7 @@ - - + Escapes (encodes) a string to URL friendly format. Also referred to as 'URL encode'. [codeblock] @@ -438,8 +350,7 @@ - - + Unescapes (decodes) a string in URL encoded format. Also referred to as 'URL decode'. [codeblock] @@ -448,10 +359,8 @@ - - - - + + Converts [code]size[/code] represented as number of bytes to human-readable format using internationalized set of data size units, namely: B, KiB, MiB, GiB, TiB, PiB, EiB. Note that the next smallest unit is picked automatically to hold at most 1024 units. [codeblock] @@ -462,170 +371,139 @@ - - - - - - + + + Returns a copy of the string with the substring [code]what[/code] inserted at the given position. - - + If the string is a path to a file or directory, returns [code]true[/code] if the path is absolute. - - + If the string is a path to a file or directory, returns [code]true[/code] if the path is relative. - - - - + + Returns [code]true[/code] if this string is a subsequence of the given string. - - - - + + Returns [code]true[/code] if this string is a subsequence of the given string, without considering case. - - + Returns [code]true[/code] if this string is free from characters that aren't allowed in file names, those being: [code]: / \ ? * " | % < >[/code] - - + Returns [code]true[/code] if this string contains a valid float. - - - - + + Returns [code]true[/code] if this string contains a valid hexadecimal number. If [code]with_prefix[/code] is [code]true[/code], then a validity of the hexadecimal number is determined by [code]0x[/code] prefix, for instance: [code]0xDEADC0DE[/code]. - - + Returns [code]true[/code] if this string contains a valid color in hexadecimal HTML notation. Other HTML notations such as named colors or [code]hsl()[/code] colors aren't considered valid by this method and will return [code]false[/code]. - - + Returns [code]true[/code] if this string is a valid identifier. A valid identifier may contain only letters, digits and underscores ([code]_[/code]) and the first character may not be a digit. - - + Returns [code]true[/code] if this string contains a valid integer. - - + Returns [code]true[/code] if this string contains only a well-formatted IPv4 or IPv6 address. This method considers [url=https://en.wikipedia.org/wiki/Reserved_IP_addresses]reserved IP addresses[/url] such as [code]0.0.0.0[/code] as valid. - - + Returns a copy of the string with special characters escaped using the JSON standard. - - - - + + Returns a number of characters from the left of the string. - - + Returns the string's amount of characters. - - - - + + Returns a copy of the string with characters removed from the left. The [code]chars[/code] argument is a string specifying the set of characters to be removed. [b]Note:[/b] The [code]chars[/code] is not a prefix. See [method trim_prefix] method that will remove a single prefix string rather than a set of characters. - - - - + + Does a simple case-sensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). - - - - + + Does a simple case-insensitive expression match, where [code]"*"[/code] matches zero or more arbitrary characters and [code]"?"[/code] matches any single character except a period ([code]"."[/code]). - - + Returns the MD5 hash of the string as an array of bytes. - - + Returns the MD5 hash of the string as a string. - - - - + + Performs a case-insensitive [i]natural order[/i] comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/code] of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison. When used for sorting, natural order comparison will order suites of numbers as expected by most people. If you sort the numbers from 1 to 10 using natural order, you will get [code][1, 2, 3, ...][/code] instead of [code][1, 10, 2, 3, ...][/code]. @@ -635,10 +513,8 @@ - - - - + + Performs a case-insensitive comparison to another string. Returns [code]-1[/code] if less than, [code]1[/code] if greater than, or [code]0[/code] if equal. "less than" or "greater than" are determined by the [url=https://en.wikipedia.org/wiki/List_of_Unicode_characters]Unicode code points[/code] of each string, which roughly matches the alphabetical order. Internally, lowercase characters will be converted to uppercase during the comparison. [b]Behavior with different string lengths:[/b] Returns [code]1[/code] if the "base" string is longer than the [code]to[/code] string or [code]-1[/code] if the "base" string is shorter than the [code]to[/code] string. Keep in mind this length is determined by the number of Unicode codepoints, [i]not[/i] the actual visible characters. @@ -647,126 +523,96 @@ - - - - + + Returns the character code at position [code]at[/code]. - - - - + + Formats a number to have an exact number of [code]digits[/code] after the decimal point. - - - - + + Formats a number to have an exact number of [code]digits[/code] before the decimal point. - - + Decode a percent-encoded string. See [method percent_encode]. - - + Percent-encodes a string. Encodes parameters in a URL when sending a HTTP GET request (and bodies of form-urlencoded POST requests). - - - - + + If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code]. - - - - + + Returns original string repeated a number of times. The number of repetitions is given by the argument. - - - - - - + + + Replaces occurrences of a case-sensitive substring with the given one inside the string. - - - - - - + + + Replaces occurrences of a case-insensitive substring with the given one inside the string. - - - - - - + + + Performs a case-sensitive search for a substring, but starts from the end of the string instead of the beginning. - - - - - - + + + Performs a case-insensitive search for a substring, but starts from the end of the string instead of the beginning. - - - - + + Returns the right side of the string from a given position. - - - - - - - - + + + + Splits the string by a [code]delimiter[/code] string and returns an array of the substrings, starting from right. The splits in the returned array are sorted in the same order as the original string, from left to right. @@ -782,61 +628,49 @@ - - - - + + Returns a copy of the string with characters removed from the right. The [code]chars[/code] argument is a string specifying the set of characters to be removed. [b]Note:[/b] The [code]chars[/code] is not a suffix. See [method trim_suffix] method that will remove a single suffix string rather than a set of characters. - - + Returns the SHA-1 hash of the string as an array of bytes. - - + Returns the SHA-1 hash of the string as a string. - - + Returns the SHA-256 hash of the string as an array of bytes. - - + Returns the SHA-256 hash of the string as a string. - - - - + + Returns the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. - - - - - - - - + + + + Splits the string by a [code]delimiter[/code] string and returns an array of the substrings. The [code]delimiter[/code] can be of any length. If [code]maxsplit[/code] is specified, it defines the number of splits to do from the left up to [code]maxsplit[/code]. The default value of [code]0[/code] means that all items are split. @@ -852,130 +686,106 @@ - - - - - - + + + Splits the string in floats by using a delimiter string and returns an array of the substrings. For example, [code]"1,2.5,3"[/code] will return [code][1,2.5,3][/code] if split by [code]","[/code]. - - - - - - + + + Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. - - + Returns a copy of the string stripped of any escape character. These include all non-printable control characters of the first page of the ASCII table (< 32), such as tabulation ([code]\t[/code] in C) and newline ([code]\n[/code] and [code]\r[/code]) characters, but not spaces. - - - - - - + + + Returns part of the string from the position [code]from[/code] with length [code]len[/code]. Argument [code]len[/code] is optional and using [code]-1[/code] will return remaining characters from given position. - - + Converts the String (which is a character array) to [PoolByteArray] (which is an array of bytes). The conversion is faster compared to [method to_utf8], as this method assumes that all the characters in the String are ASCII characters. - - + Converts a string containing a decimal number into a [code]float[/code]. - - + Converts a string containing an integer number into an [code]int[/code]. - - + Returns the string converted to lowercase. - - + Returns the string converted to uppercase. - - + Converts the String (which is an array of characters) to [PoolByteArray] (which is an array of bytes). The conversion is a bit slower than [method to_ascii], but supports all UTF-8 characters. Therefore, you should prefer this function over [method to_ascii]. - - + Converts the String (which is an array of characters) to [PoolByteArray] (which is an array of bytes). - - - - + + Removes a given string from the start if it starts with it or leaves the string unchanged. - - - - + + Removes a given string from the end if it ends with it or leaves the string unchanged. - - + Removes any characters from the string that are prohibited in [Node] names ([code].[/code] [code]:[/code] [code]@[/code] [code]/[/code] [code]"[/code]). - - + Returns a copy of the string with special characters escaped using the XML standard. - - + Returns a copy of the string with escaped characters replaced by their meanings according to the XML standard. diff --git a/doc/classes/StyleBox.xml b/doc/classes/StyleBox.xml index 8f0f4e3bed8..32a17ff8c41 100644 --- a/doc/classes/StyleBox.xml +++ b/doc/classes/StyleBox.xml @@ -11,82 +11,65 @@ - - - - - - + + + Draws this stylebox using a [CanvasItem] with given [RID]. You can get a [RID] value using [method Object.get_instance_id] on a [CanvasItem]-derived node. - - + Returns the size of this [StyleBox] without the margins. - - + Returns the [CanvasItem] that handles its [constant CanvasItem.NOTIFICATION_DRAW] or [method CanvasItem._draw] callback at this moment. - - - - + + Returns the default value of the specified [enum Margin]. - - - - + + Returns the content margin offset for the specified [enum Margin]. Positive values reduce size inwards, unlike [Control]'s margin values. - - + Returns the minimum size that this stylebox can be shrunk to. - - + Returns the "offset" of a stylebox. This helper function returns a value equivalent to [code]Vector2(style.get_margin(MARGIN_LEFT), style.get_margin(MARGIN_TOP))[/code]. - - - - - - + + + Sets the default value of the specified [enum Margin] to given [code]offset[/code] in pixels. - - - - - - + + + Test a position in a rectangle, return whether it passes the mask test. diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 8574ae3fc84..41c76675c63 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -25,125 +25,93 @@ - - - - + + Returns the given [code]margin[/code]'s border width. See [enum Margin] for possible values. - - + Returns the smallest border width out of all four borders. - - - - + + Returns the given [code]corner[/code]'s radius. See [enum Corner] for possible values. - - - - + + Returns the size of the given [code]margin[/code]'s expand margin. See [enum Margin] for possible values. - - - - - - + + + Sets the border width to [code]width[/code] pixels for the given [code]margin[/code]. See [enum Margin] for possible values. - - - - + + Sets the border width to [code]width[/code] pixels for all margins. - - - - - - + + + Sets the corner radius to [code]radius[/code] pixels for the given [code]corner[/code]. See [enum Corner] for possible values. - - - - + + Sets the corner radius to [code]radius[/code] pixels for all corners. - - - - - - - - - - + + + + + Sets the corner radius for each corner to [code]radius_top_left[/code], [code]radius_top_right[/code], [code]radius_bottom_right[/code], and [code]radius_bottom_left[/code] pixels. - - - - - - + + + Sets the expand margin to [code]size[/code] pixels for the given [code]margin[/code]. See [enum Margin] for possible values. - - - - + + Sets the expand margin to [code]size[/code] pixels for all margins. - - - - - - - - - - + + + + + Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels. diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index 9cf8f476c23..2e5fe6f3af3 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -10,65 +10,48 @@ - - - - + + Returns the size of the given [code]margin[/code]'s expand margin. See [enum Margin] for possible values. - - - - + + Returns the size of the given [code]margin[/code]. See [enum Margin] for possible values. - - - - + + Sets the expand margin to [code]size[/code] pixels for all margins. - - - - - - - - - - + + + + + Sets the expand margin for each margin to [code]size_left[/code], [code]size_top[/code], [code]size_right[/code], and [code]size_bottom[/code] pixels. - - - - - - + + + Sets the expand margin to [code]size[/code] pixels for the given [code]margin[/code]. See [enum Margin] for possible values. - - - - - - + + + Sets the margin to [code]size[/code] pixels for the given [code]margin[/code]. See [enum Margin] for possible values. diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index b764824c8a5..5e16bbe5db5 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -23,224 +23,172 @@ - - - - + + Specifies an array of bones to use for the [i]next[/i] vertex. [code]bones[/code] must contain 4 integers. - - - - + + Specifies a [Color] to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. [b]Note:[/b] The material must have [member SpatialMaterial.vertex_color_use_as_albedo] enabled for the vertex color to be visible. - - - - + + Adds an index to index array if you are using indexed vertices. Does not need to be called before adding vertices. - - - - + + Specifies a normal to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - - - - + + Specifies whether the current vertex (if using only vertex arrays) or current index (if also using index arrays) should use smooth normals for normal calculation. - - - - + + Specifies a tangent to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - - - - - - - - - - - - - - + + + + + + + Inserts a triangle fan made of array data into [Mesh] being constructed. Requires the primitive type be set to [constant Mesh.PRIMITIVE_TRIANGLES]. - - - - + + Specifies a set of UV coordinates to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - - - - + + Specifies an optional second set of UV coordinates to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - - - - + + Specifies the position of current vertex. Should be called after specifying other vertex properties (e.g. Color, UV). - - - - + + Specifies weight values to use for the [i]next[/i] vertex. [code]weights[/code] must contain 4 values. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all. - - - - - - - - + + + + Append vertices from a given [Mesh] surface onto the current vertex array with specified [Transform]. - - - - + + Called before adding any vertices. Takes the primitive type as an argument (e.g. [constant Mesh.PRIMITIVE_TRIANGLES]). - - + Clear all information passed into the surface tool so far. - - - - - - + + + Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. Default flag is [constant Mesh.ARRAY_COMPRESS_DEFAULT]. See [code]ARRAY_COMPRESS_*[/code] constants in [enum Mesh.ArrayFormat] for other flags. - - + Commits the data to the same format used by [method ArrayMesh.add_surface_from_arrays]. This way you can further process the mesh data using the [ArrayMesh] API. - - - - - - + + + Creates a vertex array from an existing [Mesh]. - - - - - - - - + + + + Creates a vertex array from the specified blend shape of an existing [Mesh]. This can be used to extract a specific pose from a blend shape. - - + Removes the index array by expanding the vertex array. - - - - + + Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays]. [b]Note:[/b] [method generate_normals] only works if the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES]. - - + Generates a tangent vector for each vertex. Requires that each vertex have UVs and normals set already. - - + Shrinks the vertex array by creating an index array. This can improve performance by avoiding vertex reuse. - - - - + + Sets [Material] to be used by the [Mesh] you are constructing. diff --git a/doc/classes/TCP_Server.xml b/doc/classes/TCP_Server.xml index 35cfdd22fbc..9168486feec 100644 --- a/doc/classes/TCP_Server.xml +++ b/doc/classes/TCP_Server.xml @@ -10,26 +10,21 @@ - - + Returns [code]true[/code] if a connection is available for taking. - - + Returns [code]true[/code] if the server is currently listening for connections. - - - - - - + + + Listen on the [code]port[/code] binding to [code]bind_address[/code]. If [code]bind_address[/code] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6). @@ -38,15 +33,13 @@ - - + Stops listening. - - + If a connection is available, returns a StreamPeerTCP with the connection. diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index 159324afe9c..d654242db94 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -13,124 +13,98 @@ - - + Returns the child [Control] node located at the active tab index. - - + Returns the [Popup] node instance if one has been set already with [method set_popup]. - - + Returns the previously active tab index. - - - - + + Returns the [Control] node from the tab at index [code]tab_idx[/code]. - - + Returns the number of tabs. - - - - + + Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. - - - - + + Returns the [Texture] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture]. - - - - + + Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. - - + Returns the [TabContainer] rearrange group id. - - - - + + If set on a [Popup] node instance, a popup menu icon appears in the top-right corner of the [TabContainer]. Clicking it will expand the [Popup] node. - - - - - - + + + If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. [b]Note:[/b] Its title text will remain, unless also removed with [method set_tab_title]. - - - - - - + + + Sets an icon for the tab at index [code]tab_idx[/code]. - - - - - - + + + Sets a title for the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. - - - - + + Defines rearrange group id, choose for each [TabContainer] the same value to enable tab drag between [TabContainer]. Enable drag with [code]set_drag_to_rearrange_enabled(true)[/code]. @@ -163,15 +137,13 @@ - - + Emitted when switching to another tab. - - + Emitted when a tab is selected, even if it is the current tab. diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 456f814c86d..812d43aff24 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -10,171 +10,134 @@ - - - - - - + + + Adds a new tab. - - - - + + Moves the scroll view to make the tab visible. - - + Returns [code]true[/code] if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible. - - + Returns the previously active tab index. - - + Returns [code]true[/code] if select with right mouse button is enabled. - - + Returns the number of tabs. - - - - + + Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. - - - - + + Returns the [Texture] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture]. - - + Returns the number of hidden tabs offsetted to the left. - - - - + + Returns tab [Rect2] with local position and size. - - - - + + Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title]. - - + Returns the [Tabs]' rearrange group ID. - - - - - - + + + Moves a tab from [code]from[/code] to [code]to[/code]. - - - - + + Removes the tab at index [code]tab_idx[/code]. - - - - + + If [code]true[/code], enables selecting a tab with the right mouse button. - - - - - - + + + If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. [b]Note:[/b] Its title text will remain unless it is also removed with [method set_tab_title]. - - - - - - + + + Sets an [code]icon[/code] for the tab at index [code]tab_idx[/code]. - - - - - - + + + Sets a [code]title[/code] for the tab at index [code]tab_idx[/code]. - - - - + + Defines the rearrange group ID. Choose for each [Tabs] the same value to dragging tabs between [Tabs]. Enable drag with [code]set_drag_to_rearrange_enabled(true)[/code]. @@ -199,43 +162,37 @@ - - + Emitted when the active tab is rearranged via mouse drag. See [member drag_to_rearrange_enabled]. - - + Emitted when a tab is right-clicked. - - + Emitted when switching to another tab. - - + Emitted when a tab is clicked, even if it is the current tab. - - + Emitted when a tab is closed. - - + Emitted when a tab is hovered by the mouse. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 0f7091ee93c..0c4a039a14f 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -10,105 +10,81 @@ - - - - - - - - - - + + + + + Adds color region (given the delimiters) and its colors. - - - - - - + + + Adds a [code]keyword[/code] and its [Color]. - - - - + + Returns if the given line is foldable, that is, it has indented lines right below it. - - + Centers the viewport on the line the editing cursor is at. This also resets the [member scroll_horizontal] value to [code]0[/code]. - - + Clears all custom syntax coloring information previously added with [method add_color_region] or [method add_keyword_color]. - - + Clears the undo history. - - + Copy's the current text selection. - - + Returns the column the editing cursor is at. - - + Returns the line the editing cursor is at. - - - - - - + + + Moves the cursor at the specified [code]column[/code] index. If [code]adjust_viewport[/code] is set to [code]true[/code], the viewport will center at the cursor position after the move occurs. - - - - - - - - - - + + + + + Moves the cursor at the specified [code]line[/code] index. If [code]adjust_viewport[/code] is set to [code]true[/code], the viewport will center at the cursor position after the move occurs. @@ -116,227 +92,184 @@ - - + Cut's the current selection. - - + Deselects the current selection. - - + Folds all lines that are possible to be folded (see [method can_fold]). - - - - + + Folds the given line, if possible (see [method can_fold]). - - + Returns an array containing the line number of each breakpoint. - - - - + + Returns the [Color] of the specified [code]keyword[/code]. - - - - + + Returns the text of a specific line. - - + Returns the amount of total lines in the text. - - + Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit]. - - + Returns the selection begin column. - - + Returns the selection begin line. - - + Returns the text inside the selection. - - + Returns the selection end column. - - + Returns the selection end line. - - + Returns a [String] text with the word under the caret (text cursor) location. - - - - + + Returns whether the specified [code]keyword[/code] has a color set to it or not. - - - - + + Insert the specified text at the cursor position. - - - - + + Returns whether the line at the specified index is folded or not. - - - - + + Returns whether the line at the specified index is hidden or not. - - - - + + Returns [code]true[/code] when the specified [code]line[/code] is bookmarked. - - - - + + Returns [code]true[/code] when the specified [code]line[/code] has a breakpoint. - - - - + + Returns [code]true[/code] when the specified [code]line[/code] is marked as safe. - - + Returns [code]true[/code] if the selection is active. - - - - + + Triggers a right-click menu action by the specified index. See [enum MenuItems] for a list of available indexes. - - + Paste the current selection. - - + Perform redo operation. - - + Removes all the breakpoints. This will not fire the [signal breakpoint_toggled] signal. - - - - - - - - - - + + + + + Perform a search inside the text. Search flags can be specified in the [enum SearchFlags] enum. Returns an empty [code]PoolIntArray[/code] if no result was found. Otherwise, the result line and column can be accessed at indices specified in the [enum SearchResult] enum, e.g: @@ -350,114 +283,87 @@ - - - - - - - - - - + + + + + Perform selection, from line/column to line/column. If [member selecting_enabled] is [code]false[/code], no selection will occur. - - + Select all the text. If [member selecting_enabled] is [code]false[/code], no selection will occur. - - - - - - + + + Sets the text for a specific line. - - - - - - + + + Bookmarks the [code]line[/code] if [code]bookmark[/code] is true. Deletes the bookmark if [code]bookmark[/code] is false. Bookmarks are shown in the [member breakpoint_gutter]. - - - - - - + + + Adds or removes the breakpoint in [code]line[/code]. Breakpoints are shown in the [member breakpoint_gutter]. - - - - - - + + + If [code]true[/code], hides the line of the specified index. - - - - - - + + + If [code]true[/code], marks the [code]line[/code] as safe. This will show the line number with the color provided in the [code]safe_line_number_color[/code] theme property. - - - - + + Toggle the folding of the code block at the given line. - - + Perform undo operation. - - - - + + Unfolds the given line, if folded. - - + Unhide all lines that were previously set to hidden by [method set_line_as_hidden]. @@ -553,8 +459,7 @@ - - + Emitted when a breakpoint is placed via the breakpoint gutter. @@ -565,10 +470,8 @@ - - - - + + Emitted when the info icon is clicked. @@ -578,12 +481,9 @@ - - - - - - + + + diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index 828ccddb9d2..30fd7d75dc1 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -13,93 +13,67 @@ - - - - - - - - - - - - + + + + + + Draws the texture using a [CanvasItem] with the [VisualServer] API at the specified [code]position[/code]. Equivalent to [method VisualServer.canvas_item_add_texture_rect] with a rect at [code]position[/code] and the size of this [Texture]. - - - - - - - - - - - - - - + + + + + + + Draws the texture using a [CanvasItem] with the [VisualServer] API. Equivalent to [method VisualServer.canvas_item_add_texture_rect]. - - - - - - - - - - - - - - - - + + + + + + + + Draws a part of the texture using a [CanvasItem] with the [VisualServer] API. Equivalent to [method VisualServer.canvas_item_add_texture_rect_region]. - - + Returns an [Image] that is a copy of data from this [Texture]. [Image]s can be accessed and manipulated directly. - - + Returns the texture height. - - + Returns the texture size. - - + Returns the texture width. - - + Returns [code]true[/code] if this [Texture] has an alpha channel. diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml index b987fe731e6..e32d797b8a5 100644 --- a/doc/classes/TextureLayered.xml +++ b/doc/classes/TextureLayered.xml @@ -10,83 +10,62 @@ - - - - - - - - - - - - + + + + + + Creates the [Texture3D] or [TextureArray] with specified [code]width[/code], [code]height[/code], and [code]depth[/code]. See [enum Image.Format] for [code]format[/code] options. See [enum Flags] enumerator for [code]flags[/code] options. - - + Returns the depth of the texture. Depth is the 3rd dimension (typically Z-axis). - - + Returns the current format being used by this texture. See [enum Image.Format] for details. - - + Returns the height of the texture. Height is typically represented by the Y-axis. - - - - + + Returns an [Image] resource with the data from specified [code]layer[/code]. - - + Returns the width of the texture. Width is typically represented by the X-axis. - - - - - - - - - - - - + + + + + + Partially sets the data for a specified [code]layer[/code] by overwriting using the data of the specified [code]image[/code]. [code]x_offset[/code] and [code]y_offset[/code] determine where the [Image] is "stamped" over the texture. The [code]image[/code] must fit within the texture. - - - - - - + + + Sets the data for the specified layer. Data takes the form of a 2-dimensional [Image] resource. diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml index 899fe2765c8..2f16955e6a9 100644 --- a/doc/classes/TextureProgress.xml +++ b/doc/classes/TextureProgress.xml @@ -10,20 +10,15 @@ - - - - + + - - - - - - + + + diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml index 89b0395b8e1..5c185d8a80a 100644 --- a/doc/classes/Theme.xml +++ b/doc/classes/Theme.xml @@ -12,326 +12,244 @@ - - + Clears all values on the theme. - - - - - - + + + Clears the [Color] at [code]name[/code] if the theme has [code]node_type[/code]. - - - - - - + + + Clears the constant at [code]name[/code] if the theme has [code]node_type[/code]. - - - - - - + + + Clears the [Font] at [code]name[/code] if the theme has [code]node_type[/code]. - - - - - - + + + Clears the icon at [code]name[/code] if the theme has [code]node_type[/code]. - - - - - - + + + Clears [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code]. - - + Sets the theme's values to a copy of the default theme values. - - - - + + Sets the theme's values to a copy of a given theme. - - - - - - + + + Returns the [Color] at [code]name[/code] if the theme has [code]node_type[/code]. - - - - + + Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]node_type[/code]. - - - - - - + + + Returns the constant at [code]name[/code] if the theme has [code]node_type[/code]. - - - - + + Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]node_type[/code]. - - - - - - + + + Returns the [Font] at [code]name[/code] if the theme has [code]node_type[/code]. - - - - + + Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]node_type[/code]. - - - - - - + + + Returns the icon [Texture] at [code]name[/code] if the theme has [code]node_type[/code]. - - - - + + Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the theme has [code]node_type[/code]. - - - - - - + + + Returns the [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code]. Valid [code]name[/code]s may be found using [method get_stylebox_list]. Valid [code]node_type[/code]s may be found using [method get_stylebox_types]. - - - - + + Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]node_type[/code]. Valid [code]node_type[/code]s may be found using [method get_stylebox_types]. - - + Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the theme has [code]node_type[/code]. - - - - + + Returns all the types in [code]node_type[/code] as a [PoolStringArray] for use in any of the [code]get_*[/code] functions, if the theme has [code]node_type[/code]. - - - - - - + + + Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]node_type[/code]. Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - - - - - + + + Returns [code]true[/code] if constant with [code]name[/code] is in [code]node_type[/code]. Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - - - - - + + + Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]node_type[/code]. Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - - - - - + + + Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]node_type[/code]. Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - - - - - + + + Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]node_type[/code]. Returns [code]false[/code] if the theme does not have [code]node_type[/code]. - - - - - - - - + + + + Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]node_type[/code]. Does nothing if the theme does not have [code]node_type[/code]. - - - - - - - - + + + + Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]node_type[/code]. Does nothing if the theme does not have [code]node_type[/code]. - - - - - - - - + + + + Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]node_type[/code]. Does nothing if the theme does not have [code]node_type[/code]. - - - - - - - - + + + + Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]node_type[/code]. Does nothing if the theme does not have [code]node_type[/code]. - - - - - - - - + + + + Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]node_type[/code]. Does nothing if the theme does not have [code]node_type[/code]. diff --git a/doc/classes/Thread.xml b/doc/classes/Thread.xml index 4b2b08a3b24..c71181d5687 100644 --- a/doc/classes/Thread.xml +++ b/doc/classes/Thread.xml @@ -14,38 +14,30 @@ - - + Returns the current [Thread]'s ID, uniquely identifying it among all threads. If the [Thread] is not running this returns an empty string. - - + Returns [code]true[/code] if this [Thread] is currently active. An active [Thread] cannot start work on a new method but can be joined with [method wait_to_finish]. - - - - - - - - - - + + + + + Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]method[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum. Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure. - - + Joins the [Thread] and waits for it to finish. Returns what the method called returned. diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index a203dee555a..5942a0221c1 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -18,131 +18,101 @@ - - + Clears all cells. - - + Clears cells that do not exist in the tileset. - - - - - - + + + Returns the tile index of the given cell. If no tile exists in the cell, returns [constant INVALID_CELL]. - - - - - - + + + Returns the coordinate (subtile column and row) of the autotile variation in the tileset. Returns a zero vector if the cell doesn't have autotiling. - - - - + + Returns the tile index of the cell given by a Vector2. If no tile exists in the cell, returns [constant INVALID_CELL]. - - - - + + Returns [code]true[/code] if the given collision layer bit is set. - - - - + + Returns [code]true[/code] if the given collision mask bit is set. - - + Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]). - - - - + + Returns an array of all cells with the given tile index specified in [code]id[/code]. - - + Returns a rectangle enclosing the used (non-empty) tiles of the map. - - - - - - + + + Returns [code]true[/code] if the given cell is transposed, i.e. the X and Y axes are swapped. - - - - - - + + + Returns [code]true[/code] if the given cell is flipped in the X axis. - - - - - - + + + Returns [code]true[/code] if the given cell is flipped in the Y axis. - - - - - - + + + Returns the local position of the top left corner of the cell corresponding to the given tilemap (grid-based) coordinates. To get the global position, use [method Node2D.to_global]: @@ -154,22 +124,14 @@ - - - - - - - - - - - - - - - - + + + + + + + + Sets the tile index for the cell given by a Vector2. An index of [code]-1[/code] clears the cell. @@ -186,18 +148,12 @@ - - - - - - - - - - - - + + + + + + Sets the tile index for the given cell. An index of [code]-1[/code] clears the cell. @@ -207,60 +163,46 @@ - - - - - - + + + Sets the given collision layer bit. - - - - - - + + + Sets the given collision mask bit. - - - - + + Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based X and Y coordinates. - - - - - - + + + Applies autotiling rules to the cells in the given region (specified by grid-based X and Y coordinates). Calling with invalid (or missing) parameters applies autotiling rules for the entire tilemap. - - + Updates the tile map's quadrants, allowing things such as navigation and collision shapes to be immediately used if modified. - - - - + + Returns the tilemap (grid-based) coordinates corresponding to the given local position. To use this with a global position, first determine the local position with [method Node2D.to_local]: diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index fe89f47164b..d903b175e6c 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -18,472 +18,351 @@ - - - - - - - - + + + + - - - - - - - - - - + + + + + - - - - - - + + + Determines when the auto-tiler should consider two different auto-tile IDs to be bound together. [b]Note:[/b] [code]neighbor_id[/code] will be [code]-1[/code] ([constant TileMap.INVALID_CELL]) when checking a tile against an empty neighbor tile. - - - - + + Clears all bitmask information of the autotile. - - - - - - + + + Returns the bitmask of the subtile from an autotile given its coordinates. The value is the sum of the values in [enum AutotileBindings] present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right). - - - - + + Returns the [enum BitmaskMode] of the autotile. - - - - + + Returns the subtile that's being used as an icon in an atlas/autotile given its coordinates. The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor. - - - - - - + + + Returns the light occluder of the subtile from an atlas/autotile given its coordinates. - - - - - - + + + Returns the navigation polygon of the subtile from an atlas/autotile given its coordinates. - - - - + + Returns the size of the subtiles in an atlas/autotile. - - - - + + Returns the spacing between subtiles of the atlas/autotile. - - - - - - + + + Returns the priority of the subtile from an autotile given its coordinates. When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked. - - - - - - + + + Returns the drawing index of the subtile from an atlas/autotile given its coordinates. - - - - - - - - + + + + Sets the bitmask of the subtile from an autotile given its coordinates. The value is the sum of the values in [enum AutotileBindings] present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right). - - - - - - + + + Sets the [enum BitmaskMode] of the autotile. - - - - - - + + + Sets the subtile that will be used as an icon in an atlas/autotile given its coordinates. The subtile defined as the icon will be used as a fallback when the atlas/autotile's bitmask information is incomplete. It will also be used to represent it in the TileSet editor. - - - - - - - - + + + + Sets the light occluder of the subtile from an atlas/autotile given its coordinates. - - - - - - - - + + + + Sets the navigation polygon of the subtile from an atlas/autotile given its coordinates. - - - - - - + + + Sets the size of the subtiles in an atlas/autotile. - - - - - - + + + Sets the spacing between subtiles of the atlas/autotile. - - - - - - - - + + + + Sets the priority of the subtile from an autotile given its coordinates. When more than one subtile has the same bitmask value, one of them will be picked randomly for drawing. Its priority will define how often it will be picked. - - - - - - - - + + + + Sets the drawing index of the subtile from an atlas/autotile given its coordinates. - - + Clears all tiles. - - - - + + Creates a new tile with the given ID. - - - - + + Returns the first tile matching the given name. - - + Returns the ID following the last currently used ID, useful when creating a new tile. - - + Returns an array of all currently used tile IDs. - - - - + + Removes the given tile ID. - - - - - - - - - - - - + + + + + + Adds a shape to the tile. - - - - + + Returns the tile's light occluder. - - - - + + Returns the tile's material. - - - - + + Returns the tile's modulation color. - - - - + + Returns the tile's name. - - - - + + Returns the navigation polygon of the tile. - - - - + + Returns the offset of the tile's navigation polygon. - - - - + + Returns the tile's normal map texture. - - - - + + Returns the offset of the tile's light occluder. - - - - + + Returns the tile sub-region in the texture. - - - - - - + + + Returns a tile's given shape. - - - - + + Returns the number of shapes assigned to a tile. - - - - - - + + + Returns the offset of a tile's shape. - - - - - - + + + Returns the one-way collision value of a tile's shape. - - - - - - + + + - - - - - - + + + Returns the [Transform2D] of a tile's shape. - - - - + + Returns an array of dictionaries describing the tile's shapes. [b]Dictionary structure in the array returned by this method:[/b] @@ -499,256 +378,186 @@ - - - - + + Returns the tile's texture. - - - - + + Returns the texture offset of the tile. - - - - + + Returns the tile's [enum TileMode]. - - - - + + Returns the tile's Z index (drawing layer). - - - - - - + + + Sets a light occluder for the tile. - - - - - - + + + Sets the tile's material. - - - - - - + + + Sets the tile's modulation color. - - - - - - + + + Sets the tile's name. - - - - - - + + + Sets the tile's navigation polygon. - - - - - - + + + Sets an offset for the tile's navigation polygon. - - - - - - + + + Sets the tile's normal map texture. [b]Note:[/b] Godot expects the normal map to use X+, Y-, and Z+ coordinates. See [url=http://wiki.polycount.com/wiki/Normal_Map_Technical_Details#Common_Swizzle_Coordinates]this page[/url] for a comparison of normal map coordinates expected by popular engines. - - - - - - + + + Sets an offset for the tile's light occluder. - - - - - - + + + Sets the tile's sub-region in the texture. This is common in texture atlases. - - - - - - - - + + + + Sets a shape for the tile, enabling collision. - - - - - - - - + + + + Sets the offset of a tile's shape. - - - - - - - - + + + + Enables one-way collision on a tile's shape. - - - - - - - - + + + + - - - - - - - - + + + + Sets a [Transform2D] on a tile's shape. - - - - - - + + + Sets an array of shapes for the tile, enabling collision. - - - - - - + + + Sets the tile's texture. - - - - - - + + + Sets the tile's texture offset. - - - - - - + + + Sets the tile's [enum TileMode]. - - - - - - + + + Sets the tile's drawing index. diff --git a/doc/classes/Timer.xml b/doc/classes/Timer.xml index 59460911d14..94e96b9acb1 100644 --- a/doc/classes/Timer.xml +++ b/doc/classes/Timer.xml @@ -12,25 +12,21 @@ - - + Returns [code]true[/code] if the timer is stopped. - - - - + + Starts the timer. Sets [code]wait_time[/code] to [code]time_sec[/code] if [code]time_sec > 0[/code]. This also resets the remaining time to [code]wait_time[/code]. [b]Note:[/b] this method will not resume a paused timer. See [member paused]. - - + Stops the timer. diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index b7bb0df4f5f..15eb2e00445 100644 --- a/doc/classes/TouchScreenButton.xml +++ b/doc/classes/TouchScreenButton.xml @@ -12,8 +12,7 @@ - - + Returns [code]true[/code] if this button is currently pressed. diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 834ab705b84..5b31caea2ce 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -17,99 +17,75 @@ - - - - - - - - - - + + + + + Constructs a Transform from four [Vector3] values (matrix columns). Each axis corresponds to local basis vectors (some of which may be scaled). - - - - - - + + + Constructs a Transform from a [Basis] and [Vector3]. - - - - + + Constructs a Transform from a [Transform2D]. - - - - + + Constructs a Transform from a [Quat]. The origin will be [code]Vector3(0, 0, 0)[/code]. - - - - + + Constructs the Transform from a [Basis]. The origin will be Vector3(0, 0, 0). - - + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. - - - - - - + + + Interpolates the transform to other Transform by weight amount (on the range of 0.0 to 1.0). - - + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling). - - - - + + Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. - - - - - - + + + Returns a copy of the transform rotated such that its -Z axis points towards the [code]target[/code] position. The transform will first be rotated around the given [code]up[/code] vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the [code]target[/code] and [code]up[/code] vectors. @@ -117,56 +93,44 @@ - - + Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. - - - - - - + + + Rotates the transform around the given axis by the given angle (in radians), using matrix multiplication. The axis must be a normalized vector. - - - - + + Scales basis and origin of the transform by the given scale factor, using matrix multiplication. - - - - + + Translates the transform by the given offset, relative to the transform's basis vectors. Unlike [method rotated] and [method scaled], this does not use matrix multiplication. - - - - + + Transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform. - - - - + + Inverse-transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 18ff65ab1da..ee8ee0492e6 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -15,162 +15,128 @@ - - - - + + Constructs the transform from a 3D [Transform]. - - - - - - - - + + + + Constructs the transform from 3 [Vector2] values representing [member x], [member y], and the [member origin] (the three column vectors). - - - - - - + + + Constructs the transform from a given angle (in radians) and position. - - + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. - - - - + + Returns a vector transformed (multiplied) by the basis matrix. This method does not account for translation (the origin vector). - - - - + + Returns a vector transformed (multiplied) by the inverse basis matrix. This method does not account for translation (the origin vector). - - + Returns the transform's origin (translation). - - + Returns the transform's rotation (in radians). - - + Returns the scale. - - - - - - + + + Returns a transform interpolated between this transform and another by a given [code]weight[/code] (on the range of 0.0 to 1.0). - - + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use [method affine_inverse] for transforms with scaling). - - - - + + Returns [code]true[/code] if this transform and [code]transform[/code] are approximately equal, by calling [code]is_equal_approx[/code] on each component. - - + Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1). - - - - + + Rotates the transform by the given angle (in radians), using matrix multiplication. - - - - + + Scales the transform by the given scale factor, using matrix multiplication. - - - - + + Translates the transform by the given offset, relative to the transform's basis vectors. Unlike [method rotated] and [method scaled], this does not use matrix multiplication. - - - - + + Transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. - - - - + + Inverse-transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. diff --git a/doc/classes/Translation.xml b/doc/classes/Translation.xml index cdf899430f3..c85362914aa 100644 --- a/doc/classes/Translation.xml +++ b/doc/classes/Translation.xml @@ -12,44 +12,35 @@ - - - - - - + + + Adds a message if nonexistent, followed by its translation. - - - - + + Erases a message. - - - - + + Returns a message's translation. - - + Returns the number of existing messages. - - + Returns all the messages (keys). diff --git a/doc/classes/TranslationServer.xml b/doc/classes/TranslationServer.xml index ed26a4eb976..68049a99dfe 100644 --- a/doc/classes/TranslationServer.xml +++ b/doc/classes/TranslationServer.xml @@ -12,67 +12,54 @@ - - - - + + Adds a [Translation] resource. - - + Clears the server from all translations. - - + Returns an Array of all loaded locales of the game. - - + Returns the current locale of the game. - - - - + + Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]). - - - - + + Removes the given translation from the server. - - - - + + Sets the locale of the game. - - - - + + Returns the current locale's translation for the given message (key). diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 14c78ef7111..718ad606aec 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -22,26 +22,21 @@ - - + Returns [code]true[/code] if the column titles are being shown. - - + Clears the tree. This removes all items. - - - - - - + + + Creates an item in the tree and adds it as a child of [code]parent[/code]. If [code]parent[/code] is [code]null[/code], the root item will be the parent, or the new item will be the root itself if the tree is empty. @@ -49,15 +44,13 @@ - - + Edits the selected tree item as if it was clicked. The item must be set editable with [method TreeItem.set_editable]. Returns [code]true[/code] if the item could be edited. Fails if no item is selected. - - + Makes the currently focused cell visible. This will scroll the tree if necessary. In [constant SELECT_ROW] mode, this will not do horizontal scrolling, as all the cells in the selected row is focused logically. @@ -65,44 +58,35 @@ - - - - + + Returns the column index at [code]position[/code], or -1 if no item is there. - - - - + + Returns the column's title. - - - - + + Returns the column's width in pixels. - - + Returns the rectangle for custom popups. Helper to create custom cell controls that display a popup. See [method TreeItem.set_cell_mode]. - - - - + + Returns the drop section at [code]position[/code], or -100 if no item is there. Values -1, 0, or 1 will be returned for the "above item", "on item", and "below item" drop sections, respectively. See [enum DropModeFlags] for a description of each drop section. @@ -110,8 +94,7 @@ - - + Returns the currently edited item. Can be used with [signal item_edited] to get the item that was modified. [codeblock] @@ -124,66 +107,54 @@ - - + Returns the column for the currently edited item. - - - - - - + + + Returns the rectangle area for the specified item. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns. - - - - + + Returns the tree item at the specified position (relative to the tree origin position). - - - - + + Returns the next selected item after the given one, or [code]null[/code] if the end is reached. If [code]from[/code] is [code]null[/code], this returns the first selected item. - - + Returns the last pressed button's index. - - + Returns the tree's root item, or [code]null[/code] if the tree is empty. - - + Returns the current scrolling position. - - + Returns the currently focused item, or [code]null[/code] if no item is focused. In [constant SELECT_ROW] and [constant SELECT_SINGLE] modes, the focused item is same as the selected item. In [constant SELECT_MULTI] mode, the focused item is the item under the focus cursor, not necessarily selected. @@ -191,8 +162,7 @@ - - + Returns the currently focused column, or -1 if no column is focused. In [constant SELECT_SINGLE] mode, the focused column is the selected column. In [constant SELECT_ROW] mode, the focused column is always 0 if any item is selected. In [constant SELECT_MULTI] mode, the focused column is the column under the focus cursor, and there are not necessarily any column selected. @@ -200,52 +170,39 @@ - - - - + + Causes the [Tree] to jump to the specified item. - - - - - - + + + If [code]true[/code], the column will have the "Expand" flag of [Control]. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio]. - - - - - - + + + Sets the minimum width of a column. Columns that have the "Expand" flag will use their "min_width" in a similar fashion to [member Control.size_flags_stretch_ratio]. - - - - - - + + + Sets the title of a column. - - - - + + If [code]true[/code], column titles are visible. @@ -279,12 +236,9 @@ - - - - - - + + + Emitted when a button on the tree was pressed (see [method TreeItem.add_button]). @@ -295,29 +249,25 @@ - - + Emitted when a column's title is pressed. - - + Emitted when a cell with the [constant TreeItem.CELL_MODE_CUSTOM] is clicked to be edited. - - + Emitted when the right mouse button is pressed in the empty space of the tree. - - + Emitted when the right mouse button is pressed if right mouse button selection is active and the tree is empty. @@ -328,8 +278,7 @@ - - + Emitted when an item is collapsed by a click on the folding arrow. @@ -355,8 +304,7 @@ - - + Emitted when an item is selected with the right mouse button. @@ -367,12 +315,9 @@ - - - - - - + + + Emitted instead of [code]item_selected[/code] if [code]select_mode[/code] is [constant SELECT_MULTI]. diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index ab0dbd22d92..cabcc16ecfc 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -11,623 +11,468 @@ - - - - - - - - - - - - + + + + + + Adds a button with [Texture] [code]button[/code] at column [code]column[/code]. The [code]button_idx[/code] index is used to identify the button when calling other methods. If not specified, the next available index is used, which may be retrieved by calling [method get_button_count] immediately after this method. Optionally, the button can be [code]disabled[/code] and have a [code]tooltip[/code]. - - - - + + Calls the [code]method[/code] on the actual TreeItem and its children recursively. Pass parameters as a comma separated list. - - - - + + Resets the background color for the given column to default. - - - - + + Resets the color for the given column to default. - - - - + + Deselects the given column. - - - - - - + + + Removes the button at index [code]button_idx[/code] in column [code]column[/code]. - - - - - - + + + Returns the [Texture] of the button at index [code]button_idx[/code] in column [code]column[/code]. - - - - + + Returns the number of buttons in column [code]column[/code]. May be used to get the most recently added button's index, if no index was specified. - - - - - - + + + Returns the tooltip string for the button at index [code]button_idx[/code] in column [code]column[/code]. - - - - + + Returns the column's cell mode. - - + Returns the TreeItem's first child item or a null object if there is none. - - - - + + Returns the custom background color of column [code]column[/code]. - - - - + + Returns the custom color of column [code]column[/code]. - - - - + + Returns [code]true[/code] if [code]expand_right[/code] is set. - - - - + + Returns the given column's icon [Texture]. Error if no icon is set. - - - - + + Returns the column's icon's maximum width. - - - - + + Returns the [Color] modulating the column's icon. - - - - + + Returns the icon [Texture] region as [Rect2]. - - - - + + Returns the metadata value that was set for the given column using [method set_metadata]. - - + Returns the next TreeItem in the tree or a null object if there is none. - - - - + + Returns the next visible TreeItem in the tree or a null object if there is none. If [code]wrap[/code] is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns [code]null[/code]. - - + Returns the parent TreeItem or a null object if there is none. - - + Returns the previous TreeItem in the tree or a null object if there is none. - - - - + + Returns the previous visible TreeItem in the tree or a null object if there is none. If [code]wrap[/code] is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns [code]null[/code]. - - - - + + Returns the value of a [constant CELL_MODE_RANGE] column. - - - - + + Returns a dictionary containing the range parameters for a given column. The keys are "min", "max", "step", and "expr". - - - - + + Gets the suffix string shown after the column value. - - - - + + Returns the given column's text. - - - - + + Returns the given column's text alignment. - - - - + + Returns the given column's tooltip. - - - - - - + + + Returns [code]true[/code] if the button at index [code]button_idx[/code] for the given column is disabled. - - - - + + Returns [code]true[/code] if the given column is checked. - - - - + + - - - - + + Returns [code]true[/code] if column [code]column[/code] is editable. - - - - + + Returns [code]true[/code] if column [code]column[/code] is selectable. - - - - + + Returns [code]true[/code] if column [code]column[/code] is selected. - - + Moves this TreeItem to the bottom in the [Tree] hierarchy. - - + Moves this TreeItem to the top in the [Tree] hierarchy. - - - - + + Removes the given child [TreeItem] and all its children from the [Tree]. Note that it doesn't free the item from memory, so it can be reused later. To completely remove a [TreeItem] use [method Object.free]. - - - - + + Selects the column [code]column[/code]. - - - - - - - - + + + + Sets the given column's button [Texture] at index [code]button_idx[/code] to [code]button[/code]. - - - - - - - - + + + + If [code]true[/code], disables the button at index [code]button_idx[/code] in column [code]column[/code]. - - - - - - + + + Sets the given column's cell mode to [code]mode[/code]. See [enum TreeCellMode] constants. - - - - - - + + + If [code]true[/code], the column [code]column[/code] is checked. - - - - - - + + + - - - - - - - - + + + + Sets the given column's custom background color and whether to just use it as an outline. - - - - - - + + + Sets the given column's custom color. - - - - - - - - + + + + Sets the given column's custom draw callback to [code]callback[/code] method on [code]object[/code]. The [code]callback[/code] should accept two arguments: the [TreeItem] that is drawn and its position and size as a [Rect2]. - - - - - - + + + If [code]true[/code], column [code]column[/code] is editable. - - - - - - + + + If [code]true[/code], column [code]column[/code] is expanded to the right. - - - - - - + + + Sets the given column's icon [Texture]. - - - - - - + + + Sets the given column's icon's maximum width. - - - - - - + + + Modulates the given column's icon with [code]modulate[/code]. - - - - - - + + + Sets the given column's icon's texture region. - - - - - - + + + Sets the metadata value for the given column, which can be retrieved later using [method get_metadata]. This can be used, for example, to store a reference to the original data. - - - - - - + + + Sets the value of a [constant CELL_MODE_RANGE] column. - - - - - - - - - - - - + + + + + + Sets the range of accepted values for a column. The column must be in the [constant CELL_MODE_RANGE] mode. If [code]expr[/code] is [code]true[/code], the edit mode slider will use an exponential scale as with [member Range.exp_edit]. - - - - - - + + + If [code]true[/code], the given column is selectable. - - - - - - + + + Sets a string to be shown after a column's value (for example, a unit abbreviation). - - - - - - + + + Sets the given column's text value. - - - - - - + + + Sets the given column's text alignment. See [enum TextAlign] for possible values. - - - - - - + + + Sets the given column's tooltip text. diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index 72f0fc2cf3f..3d55c67618c 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -22,318 +22,218 @@ - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + Follows [code]method[/code] of [code]object[/code] and applies the returned value on [code]target_method[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] later. Methods are called with consecutive values. Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + Follows [code]property[/code] of [code]object[/code] and applies it on [code]target_property[/code] of [code]target[/code], beginning from [code]initial_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. - - + Returns the total time needed for all tweens to end. If you have two tweens, one lasting 10 seconds and the other 20 seconds, it would return 20 seconds, as by that time all tweens would have finished. - - - - - - - - - - - - - - - - - - + + + + + + + + + Calls [code]callback[/code] of [code]object[/code] after [code]duration[/code]. [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. - - - - - - - - - - - - - - - - - - + + + + + + + + + Calls [code]callback[/code] of [code]object[/code] after [code]duration[/code] on the main thread (similar to [method Object.call_deferred]). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. - - - - - - - - - - - - - - - - - - + + + + + + + + + Animates [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are called with consecutive values. Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. - - - - - - - - - - - - - - - - - - + + + + + + + + + Animates [code]property[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Setting the initial value to [code]null[/code] uses the current value of the property. Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. - - + Returns [code]true[/code] if any tweens are currently running. [b]Note:[/b] This method doesn't consider tweens that have ended. - - - - - - + + + Stops animation and removes a tween, given its object and property/method pair. By default, all tweens are removed, unless [code]key[/code] is specified. - - + Stops animation and removes all tweens. - - - - - - + + + Resets a tween to its initial value (the one given, not the one before the tween), given its object and property/method pair. By default, all tweens are removed, unless [code]key[/code] is specified. - - + Resets all tweens to their initial values (the ones given, not those before the tween). - - - - - - + + + Continues animating a stopped tween, given its object and property/method pair. By default, all tweens are resumed, unless [code]key[/code] is specified. - - + Continues animating all stopped tweens. - - - - + + Sets the interpolation to the given [code]time[/code] in seconds. - - - - + + Activates/deactivates the tween. See also [method stop_all] and [method resume_all]. - - + Starts the tween. You can define animations both before and after this. - - - - - - + + + Stops a tween, given its object and property/method pair. By default, all tweens are stopped, unless [code]key[/code] is specified. - - + Stops animating all tweens. - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + Animates [code]method[/code] of [code]object[/code] from the value returned by [code]initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + Animates [code]property[/code] of [code]object[/code] from the current value of the [code]initial_val[/code] property of [code]initial[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Use [enum TransitionType] for [code]trans_type[/code] and [enum EaseType] for [code]ease_type[/code] parameters. These values control the timing and direction of the interpolation. See the class description for more information. - - + Returns the current time of the tween. @@ -357,32 +257,24 @@ - - - - + + Emitted when a tween ends. - - - - + + Emitted when a tween starts. - - - - - - - - + + + + Emitted at each step of the animation. diff --git a/doc/classes/UDPServer.xml b/doc/classes/UDPServer.xml index 472c3faf45a..082e218ffa6 100644 --- a/doc/classes/UDPServer.xml +++ b/doc/classes/UDPServer.xml @@ -56,47 +56,39 @@ - - + Returns [code]true[/code] if a packet with a new address/port combination was received on the socket. - - + Returns [code]true[/code] if the socket is open and listening on a port. - - - - - - + + + Starts the server by opening a UDP socket listening on the given port. You can optionally specify a [code]bind_address[/code] to only listen for packets sent to that address. See also [method PacketPeerUDP.listen]. - - + Call this method at regular intervals (e.g. inside [method Node._process]) to process new packets. And packet from known address/port pair will be delivered to the appropriate [PacketPeerUDP], any packet received from an unknown address/port pair will be added as a pending connection (see [method is_connection_available], [method take_connection]). The maximum number of pending connection is defined via [member max_pending_connections]. - - + Stops the server, closing the UDP socket if open. Will close all connected [PacketPeerUDP] accepted via [method take_connection] (remote peers will not be notified). - - + Returns the first pending connection (connected to the appropriate address/port). Will return [code]null[/code] if no new connection is available. See also [method is_connection_available], [method PacketPeerUDP.connect_to_host]. diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml index fbb6a34f77e..60bfefa8cc9 100644 --- a/doc/classes/UndoRedo.xml +++ b/doc/classes/UndoRedo.xml @@ -32,146 +32,115 @@ - - - - - - + + + Register a method that will be called when the action is committed. - - - - - - - - + + + + Register a property value change for "do". - - - - + + Register a reference for "do" that will be erased if the "do" history is lost. This is useful mostly for new nodes created for the "do" call. Do not use for resources. - - - - - - + + + Register a method that will be called when the action is undone. - - - - - - - - + + + + Register a property value change for "undo". - - - - + + Register a reference for "undo" that will be erased if the "undo" history is lost. This is useful mostly for nodes removed with the "do" call (not the "undo" call!). - - - - + + Clear the undo/redo history and associated references. Passing [code]false[/code] to [code]increase_version[/code] will prevent the version number to be increased from this. - - + Commit the action. All "do" methods/properties are called/set when this function is called. - - - - - - + + + Create a new action. After this is called, do all your calls to [method add_do_method], [method add_undo_method], [method add_do_property], and [method add_undo_property], then commit the action with [method commit_action]. The way actions are merged is dictated by the [code]merge_mode[/code] argument. See [enum MergeMode] for details. - - + Gets the name of the current action. - - + Gets the version. Every time a new action is committed, the [UndoRedo]'s version number is increased automatically. This is useful mostly to check if something changed from a saved version. - - + Returns [code]true[/code] if a "redo" action is available. - - + Returns [code]true[/code] if an "undo" action is available. - - + Returns [code]true[/code] if the [UndoRedo] is currently committing the action, i.e. running its "do" method or property change (see [method commit_action]). - - + Redo the last action. - - + Undo the last action. diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 3247bbe9df7..fe965a1a49f 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -17,26 +17,21 @@ - - - - - - + + + Constructs a new Vector2 from the given [code]x[/code] and [code]y[/code]. - - + Returns a new vector with all components in absolute values (i.e. positive). - - + Returns this vector's angle with respect to the positive X axis, or [code](1, 0)[/code] vector, in radians. For example, [code]Vector2.RIGHT.angle()[/code] will return zero, [code]Vector2.DOWN.angle()[/code] will return [code]PI / 2[/code] (a quarter turn, or 90 degrees), and [code]Vector2(1, -1).angle()[/code] will return [code]-PI / 4[/code] (a negative eighth turn, or -45 degrees). @@ -44,112 +39,87 @@ - - - - + + Returns the angle to the given vector, in radians. - - - - + + Returns the angle between the line connecting the two points and the X axis, in radians. - - + Returns the aspect ratio of this vector, the ratio of [member x] to [member y]. - - - - + + Returns the vector "bounced off" from a plane defined by the given normal. - - + Returns the vector with all components rounded up (towards positive infinity). - - - - + + Returns the vector with a maximum length by limiting its length to [code]length[/code]. - - - - + + Returns the cross product of this vector and [code]with[/code]. - - - - - - - - - - + + + + + Cubically interpolates between this vector and [code]b[/code] using [code]pre_a[/code] and [code]post_b[/code] as handles, and returns the result at position [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - - - - + + Returns the normalized vector pointing from this vector to [code]b[/code]. This is equivalent to using [code](b - a).normalized()[/code]. - - - - + + Returns the squared distance between this vector and [code]b[/code]. This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula. - - - - + + Returns the distance between this vector and [code]to[/code]. - - - - + + Returns the dot product of this vector and [code]with[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. @@ -158,164 +128,131 @@ - - + Returns the vector with all components rounded down (towards negative infinity). - - - - + + Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. - - + Returns [code]true[/code] if the vector is normalized, [code]false[/code] otherwise. - - + Returns the length (magnitude) of this vector. - - + Returns the squared length (squared magnitude) of this vector. This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula. - - - - - - + + + Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - - - - - - + + + Moves the vector toward [code]to[/code] by the fixed [code]delta[/code] amount. - - + Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. - - - - + + Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]mod[/code]. - - - - + + Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]modv[/code]'s components. - - - - + + Returns the vector projected onto the vector [code]b[/code]. - - - - + + Returns the vector reflected from a plane defined by the given normal. - - - - + + Returns the vector rotated by [code]phi[/code] radians. See also [method @GDScript.deg2rad]. - - + Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. - - + Returns the vector with each component set to one or negative one, depending on the signs of the components. If a component is zero, it returns positive one. - - - - - - + + + Returns the result of spherical linear interpolation between this vector and [code]to[/code], by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. [b]Note:[/b] Both vectors must be normalized. - - - - + + Returns this vector slid along a plane defined by the given normal. - - - - + + Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. - - + Returns a perpendicular vector rotated 90 degrees counter-clockwise compared to the original, with the same length. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index a6f11a6ee3c..3eb28c0cd63 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -17,107 +17,82 @@ - - - - - - - - + + + + Returns a Vector3 with the given components. - - + Returns a new vector with all components in absolute values (i.e. positive). - - - - + + Returns the minimum angle to the given vector, in radians. - - - - + + Returns the vector "bounced off" from a plane defined by the given normal. - - + Returns a new vector with all components rounded up (towards positive infinity). - - - - + + Returns the cross product of this vector and [code]b[/code]. - - - - - - - - - - + + + + + Performs a cubic interpolation between vectors [code]pre_a[/code], [code]a[/code], [code]b[/code], [code]post_b[/code] ([code]a[/code] is current), by the given amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - - - - + + Returns the normalized vector pointing from this vector to [code]b[/code]. This is equivalent to using [code](b - a).normalized()[/code]. - - - - + + Returns the squared distance between this vector and [code]b[/code]. This method runs faster than [method distance_to], so prefer it if you need to compare vectors or need the squared distance for some formula. - - - - + + Returns the distance between this vector and [code]b[/code]. - - - - + + Returns the dot product of this vector and [code]b[/code]. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player. The dot product will be [code]0[/code] for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees. @@ -126,196 +101,157 @@ - - + Returns a new vector with all components rounded down (towards negative infinity). - - + Returns the inverse of the vector. This is the same as [code]Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z )[/code]. - - - - + + Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GDScript.is_equal_approx] on each component. - - + Returns [code]true[/code] if the vector is normalized, [code]false[/code] otherwise. - - + Returns the length (magnitude) of this vector. - - + Returns the squared length (squared magnitude) of this vector. This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula. - - - - - - + + + Returns the result of the linear interpolation between this vector and [code]to[/code] by amount [code]t[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. - - + Returns the axis of the vector's largest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_X]. - - + Returns the axis of the vector's smallest value. See [code]AXIS_*[/code] constants. If all components are equal, this method returns [constant AXIS_Z]. - - - - - - + + + Moves this vector toward [code]to[/code] by the fixed [code]delta[/code] amount. - - + Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. - - - - + + Returns the outer product with [code]b[/code]. - - - - + + Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]mod[/code]. - - - - + + Returns a vector composed of the [method @GDScript.fposmod] of this vector's components and [code]modv[/code]'s components. - - - - + + Returns this vector projected onto another vector [code]b[/code]. - - - - + + Returns this vector reflected from a plane defined by the given normal. - - - - - - + + + Rotates this vector around a given axis by [code]phi[/code] radians. The axis must be a normalized vector. - - + Returns this vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. - - + Returns a vector with each component set to one or negative one, depending on the signs of this vector's components. If a component is zero, it returns positive one. - - - - - - + + + Returns the result of spherical linear interpolation between this vector and [code]to[/code], by amount [code]weight[/code]. [code]weight[/code] is on the range of 0.0 to 1.0, representing the amount of interpolation. [b]Note:[/b] Both vectors must be normalized. - - - - + + Returns this vector slid along a plane defined by the given normal. - - - - + + Returns this vector with each component snapped to the nearest multiple of [code]step[/code]. This can also be used to round to an arbitrary number of decimals. - - + Returns a diagonal matrix with the vector as main diagonal. This is equivalent to a Basis with no rotation or shearing and this vector's components set as the scale. diff --git a/doc/classes/VehicleWheel.xml b/doc/classes/VehicleWheel.xml index 9fb9d0eb2d7..64997ced2b9 100644 --- a/doc/classes/VehicleWheel.xml +++ b/doc/classes/VehicleWheel.xml @@ -12,22 +12,19 @@ - - + Returns the rotational speed of the wheel in revolutions per minute. - - + Returns a value between 0.0 and 1.0 that indicates whether this wheel is skidding. 0.0 is skidding (the wheel has lost grip, e.g. icy terrain), 1.0 means not skidding (the wheel has full grip, e.g. dry asphalt road). - - + Returns [code]true[/code] if this wheel is in contact with a surface. diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index 03098062162..e6283a0d23e 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -13,37 +13,32 @@ - - + Returns the video stream's name, or [code]"<No Stream>"[/code] if no video stream is assigned. - - + Returns the current frame as a [Texture]. - - + Returns [code]true[/code] if the video is playing. [b]Note:[/b] The video is still considered playing if paused during playback. - - + Starts the video playback from the beginning. If the video is paused, this will not unpause the video. - - + Stops the video playback and sets the stream position to 0. [b]Note:[/b] Although the stream position will be set to 0, the first frame of the video stream won't become the current frame. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 82670a21e7a..6f17082f112 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -23,75 +23,63 @@ - - + Returns the 3D world of the viewport, or if none the world of the parent viewport. - - + Returns the 2D world of the viewport. - - + Returns the active 3D camera. - - + Returns the total transform of the viewport. - - + Returns the topmost modal in the stack. - - + Returns the mouse position relative to the viewport. - - - - + + Returns information about the viewport from the rendering pipeline. - - - - + + Returns the [enum ShadowAtlasQuadrantSubdiv] of the specified quadrant. - - + Returns the size override set with [method set_size_override]. - - + Returns the viewport's texture. [b]Note:[/b] Due to the way OpenGL works, the resulting [ViewportTexture] is flipped vertically. You can use [method Image.flip_y] on the result of [method Texture.get_data] to flip it back, for example: @@ -102,121 +90,97 @@ - - + Returns the viewport's RID from the [VisualServer]. - - + Returns the visible rectangle in global screen coordinates. - - + Returns the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. - - + Returns [code]true[/code] if there are visible modals on-screen. - - + Returns [code]true[/code] if the viewport is currently performing a drag operation. - - - - + + - - + - - + Returns [code]true[/code] if the size override is enabled. See [method set_size_override]. - - - - + + Attaches this [Viewport] to the root [Viewport] with the specified rectangle. This bypasses the need for another node to display this [Viewport] but makes you responsible for updating the position of this [Viewport] manually. - - + Stops the input from propagating further down the [SceneTree]. - - - - - - + + + Sets the number of subdivisions to use in the specified quadrant. A higher number of subdivisions allows you to have more shadows in the scene at once, but reduces the quality of the shadows. A good practice is to have quadrants with a varying number of subdivisions and to have as few subdivisions as possible. - - - - - - - - + + + + Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size. - - - - + + - - + Forces update of the 2D and 3D worlds. - - - - + + Warps the mouse to a position relative to the viewport. @@ -325,8 +289,7 @@ - - + Emitted when a Control node grabs keyboard focus. diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 883c2cb22f3..701477c880a 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -13,21 +13,16 @@ - - - - + + Returns whether the enabler identified by given [enum Enabler] constant is active. - - - - - - + + + Sets active state of the enabler identified by given [enum Enabler] constant. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 9b1ef3351e7..7b49848323f 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -13,21 +13,16 @@ - - - - + + Returns whether the enabler identified by given [enum Enabler] constant is active. - - - - - - + + + Sets active state of the enabler identified by given [enum Enabler] constant. diff --git a/doc/classes/VisibilityNotifier.xml b/doc/classes/VisibilityNotifier.xml index 3d326249ec4..ac2035f99ac 100644 --- a/doc/classes/VisibilityNotifier.xml +++ b/doc/classes/VisibilityNotifier.xml @@ -12,8 +12,7 @@ - - + If [code]true[/code], the bounding box is on the screen. [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. @@ -27,15 +26,13 @@ - - + Emitted when the VisibilityNotifier enters a [Camera]'s view. - - + Emitted when the VisibilityNotifier exits a [Camera]'s view. diff --git a/doc/classes/VisibilityNotifier2D.xml b/doc/classes/VisibilityNotifier2D.xml index 95c5039e7e6..e8ad058c4eb 100644 --- a/doc/classes/VisibilityNotifier2D.xml +++ b/doc/classes/VisibilityNotifier2D.xml @@ -13,8 +13,7 @@ - - + If [code]true[/code], the bounding rectangle is on the screen. [b]Note:[/b] It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return [code]false[/code] right after it is instantiated, even if it will be on screen in the draw pass. @@ -38,15 +37,13 @@ - - + Emitted when the VisibilityNotifier2D enters a [Viewport]'s view. - - + Emitted when the VisibilityNotifier2D exits a [Viewport]'s view. diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index cccdcc2b198..76142a6568b 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -10,59 +10,48 @@ - - + Returns the [AABB] (also known as the bounding box) for this [VisualInstance]. See also [method get_transformed_aabb]. - - + Returns the RID of the resource associated with this [VisualInstance]. For example, if the Node is a [MeshInstance], this will return the RID of the associated [Mesh]. - - + Returns the RID of this instance. This RID is the same as the RID returned by [method VisualServer.instance_create]. This RID is needed if you want to call [VisualServer] functions directly on this [VisualInstance]. - - - - + + Returns [code]true[/code] when the specified layer is enabled in [member layers] and [code]false[/code] otherwise. - - + Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance]. Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]'s [Transform]. See also [method get_aabb]. - - - - + + Sets the resource that is instantiated by this [VisualInstance], which changes how the engine handles the [VisualInstance] under the hood. Equivalent to [method VisualServer.instance_set_base]. - - - - - - + + + Enables a particular layer in [member layers]. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index b43b993c89d..68a481927af 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -19,998 +19,701 @@ - - - - - - - - - - + + + + + Sets images to be rendered in the window margin. - - - - - - - - - - + + + + + Sets margin size, where black bars (or images, if [method black_bars_set_images] was used) are rendered. - - + Creates a camera and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]camera_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - + + + Sets the cull mask associated with this camera. The cull mask describes which 3D layers are rendered by this camera. Equivalent to [member Camera.cull_mask]. - - - - - - + + + Sets the environment used by this camera. Equivalent to [member Camera.environment]. - - - - - - - - - - - - + + + + + + Sets camera to use frustum projection. This mode allows adjusting the [code]offset[/code] argument to create "tilted frustum" effects. - - - - - - - - - - + + + + + Sets camera to use orthogonal projection, also known as orthographic projection. Objects remain the same size on the screen no matter how far away they are. - - - - - - - - - - + + + + + Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away. - - - - - - + + + Sets [Transform] of camera. - - - - - - + + + If [code]true[/code], preserves the horizontal aspect ratio which is equivalent to [constant Camera.KEEP_WIDTH]. If [code]false[/code], preserves the vertical aspect ratio which is equivalent to [constant Camera.KEEP_HEIGHT]. - - + Creates a canvas and returns the assigned [RID]. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - - - - - + + + + + Adds a circle command to the [CanvasItem]'s draw commands. - - - - - - + + + If ignore is [code]true[/code], the VisualServer does not perform clipping. - - - - - - - - - - - - - - + + + + + + + Adds a line command to the [CanvasItem]'s draw commands. - - - - - - - - - - - - - - + + + + + + + Adds a mesh command to the [CanvasItem]'s draw commands. - - - - - - - - - - + + + + + Adds a [MultiMesh] to the [CanvasItem]'s draw commands. Only affects its aabb at the moment. - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + Adds a nine patch image to the [CanvasItem]'s draw commands. See [NinePatchRect] for more explanation. - - - - - - - - - - + + + + + Adds a particle system to the [CanvasItem]'s draw commands. - - - - - - - - - - - - - - - - + + + + + + + + Adds a polygon to the [CanvasItem]'s draw commands. - - - - - - - - - - - - + + + + + + Adds a polyline, which is a line from multiple points with a width, to the [CanvasItem]'s draw commands. - - - - - - - - - - - - - - - - + + + + + + + + Adds a primitive to the [CanvasItem]'s draw commands. - - - - - - - - + + + + Adds a rectangle to the [CanvasItem]'s draw commands. - - - - - - + + + Adds a [Transform2D] command to the [CanvasItem]'s draw commands. This sets the extra_matrix uniform when executed. This affects the later commands of the canvas item. - - - - - - - - - - - - - - - - + + + + + + + + Adds a textured rect to the [CanvasItem]'s draw commands. - - - - - - - - - - - - - - - - - - + + + + + + + + + Adds a texture rect with region setting to the [CanvasItem]'s draw commands. - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + Adds a triangle array to the [CanvasItem]'s draw commands. - - - - + + Clears the [CanvasItem] and removes all commands in it. - - + Creates a new [CanvasItem] and returns its [RID]. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_item_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - + + + Sets clipping for the [CanvasItem]. - - - - - - - - + + + + Sets the [CanvasItem] to copy a rect to the backbuffer. - - - - - - - - + + + + Defines a custom drawing rectangle for the [CanvasItem]. - - - - - - + + + Enables the use of distance fields for GUI elements that are rendering distance field based fonts. - - - - - - + + + Sets [CanvasItem] to be drawn behind its parent. - - - - - - + + + Sets the index for the [CanvasItem]. - - - - - - + + + The light mask. See [LightOccluder2D] for more information on light masks. - - - - - - + + + Sets a new material to the [CanvasItem]. - - - - - - + + + Sets the color that modulates the [CanvasItem] and its children. - - - - - - + + + Sets the parent for the [CanvasItem]. The parent can be another canvas item, or it can be the root canvas that is attached to the viewport. - - - - - - + + + Sets the color that modulates the [CanvasItem] without children. - - - - - - + + + Sets if [CanvasItem]'s children should be sorted by y-position. - - - - - - + + + Sets the [CanvasItem]'s [Transform2D]. - - - - - - + + + Sets if the [CanvasItem] uses its parent's material. - - - - - - + + + Sets if the canvas item (including its children) is visible. - - - - - - + + + If this is enabled, the Z index of the parent will be added to the children's Z index. - - - - - - + + + Sets the [CanvasItem]'s Z index, i.e. its draw order (lower indexes are drawn first). - - - - - - + + + Attaches the canvas light to the canvas. Removes it from its previous canvas. - - + Creates a canvas light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_light_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - + + + Attaches a light occluder to the canvas. Removes it from its previous canvas. - - + Creates a light occluder and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_light_ocluder_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - + + + Enables or disables light occluder. - - - - - - + + + The light mask. See [LightOccluder2D] for more information on light masks. - - - - - - + + + Sets a light occluder's polygon. - - - - - - + + + Sets a light occluder's [Transform2D]. - - - - - - + + + Sets the color for a light. - - - - - - + + + Enables or disables a canvas light. - - - - - - + + + Sets a canvas light's energy. - - - - - - + + + Sets a canvas light's height. - - - - - - + + + The light mask. See [LightOccluder2D] for more information on light masks. - - - - - - + + + The binary mask used to determine which layers this canvas light's shadows affects. See [LightOccluder2D] for more information on light masks. - - - - - - - - + + + + The layer range that gets rendered with this light. - - - - - - + + + The mode of the light, see [enum CanvasLightMode] constants. - - - - - - + + + Sets the texture's scale factor of the light. Equivalent to [member Light2D.texture_scale]. - - - - - - + + + Sets the width of the shadow buffer, size gets scaled to the next power of two for this. - - - - - - + + + Sets the color of the canvas light's shadow. - - - - - - + + + Enables or disables the canvas light's shadow. - - - - - - + + + Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants. - - - - - - + + + Sets the length of the shadow's gradient. - - - - - - + + + Smoothens the shadow. The lower, the smoother. - - - - - - + + + Sets texture to be used by light. Equivalent to [member Light2D.texture]. - - - - - - + + + Sets the offset of the light's texture. Equivalent to [member Light2D.offset]. - - - - - - + + + Sets the canvas light's [Transform2D]. - - - - - - - - + + + + Sets the Z range of objects that will be affected by this light. Equivalent to [member Light2D.range_z_min] and [member Light2D.range_z_max]. - - + Creates a new light occluder polygon and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]canvas_occluder_polygon_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - + + + Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants. - - - - - - - - + + + + Sets the shape of the occluder polygon. - - - - - - + + + Sets the shape of the occluder polygon as lines. - - - - - - - - + + + + A copy of the canvas item will be drawn with a local offset of the mirroring [Vector2]. - - - - - - + + + Modulates all colors in the given canvas. - - + Creates a directional light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -1018,419 +721,289 @@ - - - - - - + + + Draws a frame. [i]This method is deprecated[/i], please use [method force_draw] instead. - - + Creates an environment and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]environment_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - - - - - - - - - + + + + + + + Sets the values to be used with the "Adjustment" post-process effect. See [Environment] for more details. - - - - - - - - - - + + + + + Sets the ambient light parameters. See [Environment] for more details. - - - - - - + + + Sets the [i]BGMode[/i] of the environment. Equivalent to [member Environment.background_mode]. - - - - - - + + + Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes). - - - - - - + + + Sets the intensity of the background color. - - - - - - + + + Sets the maximum layer to use if using Canvas background mode. - - - - - - - - - - - - - - + + + + + + + Sets the values to be used with the "DoF Far Blur" post-process effect. See [Environment] for more details. - - - - - - - - - - - - - - + + + + + + + Sets the values to be used with the "DoF Near Blur" post-process effect. See [Environment] for more details. - - - - - - - - - - - - + + + + + + Sets the variables to be used with the scene fog. See [Environment] for more details. - - - - - - - - - - - - - - - - + + + + + + + + Sets the variables to be used with the fog depth effect. See [Environment] for more details. - - - - - - - - - - - - + + + + + + Sets the variables to be used with the fog height effect. See [Environment] for more details. - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + Sets the variables to be used with the "glow" post-process effect. See [Environment] for more details. - - - - - - + + + Sets the [Sky] to be used as the environment's background when using [i]BGMode[/i] sky. Equivalent to [member Environment.background_sky]. - - - - - - + + + Sets a custom field of view for the background [Sky]. Equivalent to [member Environment.background_sky_custom_fov]. - - - - - - + + + Sets the rotation of the background [Sky] expressed as a [Basis]. Equivalent to [member Environment.background_sky_orientation]. - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + Sets the variables to be used with the "Screen Space Ambient Occlusion (SSAO)" post-process effect. See [Environment] for more details. - - - - - - - - - - - - - - - - + + + + + + + + Sets the variables to be used with the "screen space reflections" post-process effect. See [Environment] for more details. - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + Sets the variables to be used with the "tonemap" post-process effect. See [Environment] for more details. - - + Removes buffers and clears testcubes. - - - - - - + + + Forces a frame to be drawn when the function is called. Drawing a frame updates all [Viewport]s that are set to update. Use with extreme caution. - - + Synchronizes threads. - - - - + + Tries to free an object in the VisualServer. - - - - + + Returns a certain information, see [enum RenderInfo] for options. - - + Returns the id of the test cube. Creates one if none exists. - - + Returns the id of the test texture. Creates one if none exists. - - + Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). [b]Note:[/b] When running a headless or server binary, this function returns an empty string. - - + Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). [b]Note:[/b] When running a headless or server binary, this function returns an empty string. - - + Returns the id of a white texture. Creates one if none exists. - - + Creates a GI probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]gi_probe_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -1438,287 +1011,217 @@ - - - - + + Returns the bias value for the GI probe. Bias is used to avoid self occlusion. Equivalent to [member GIProbeData.bias]. - - - - + + Returns the axis-aligned bounding box that covers the full extent of the GI probe. - - - - + + Returns the cell size set by [method gi_probe_set_cell_size]. - - - - + + Returns the data used by the GI probe. - - - - + + Returns the dynamic range set for this GI probe. Equivalent to [member GIProbe.dynamic_range]. - - - - + + Returns the energy multiplier for this GI probe. Equivalent to [member GIProbe.energy]. - - - - + + Returns the normal bias for this GI probe. Equivalent to [member GIProbe.normal_bias]. - - - - + + Returns the propagation value for this GI probe. Equivalent to [member GIProbe.propagation]. - - - - + + Returns the Transform set by [method gi_probe_set_to_cell_xform]. - - - - + + Returns [code]true[/code] if the GI probe data associated with this GI probe is compressed. Equivalent to [member GIProbe.compress]. - - - - + + Returns [code]true[/code] if the GI probe is set to interior, meaning it does not account for sky light. Equivalent to [member GIProbe.interior]. - - - - - - + + + Sets the bias value to avoid self-occlusion. Equivalent to [member GIProbe.bias]. - - - - - - + + + Sets the axis-aligned bounding box that covers the extent of the GI probe. - - - - - - + + + Sets the size of individual cells within the GI probe. - - - - - - + + + Sets the compression setting for the GI probe data. Compressed data will take up less space but may look worse. Equivalent to [member GIProbe.compress]. - - - - - - + + + Sets the data to be used in the GI probe for lighting calculations. Normally this is created and called internally within the [GIProbe] node. You should not try to set this yourself. - - - - - - + + + Sets the dynamic range of the GI probe. Dynamic range sets the limit for how bright lights can be. A smaller range captures greater detail but limits how bright lights can be. Equivalent to [member GIProbe.dynamic_range]. - - - - - - + + + Sets the energy multiplier for this GI probe. A higher energy makes the indirect light from the GI probe brighter. Equivalent to [member GIProbe.energy]. - - - - - - + + + Sets the interior value of this GI probe. A GI probe set to interior does not include the sky when calculating lighting. Equivalent to [member GIProbe.interior]. - - - - - - + + + Sets the normal bias for this GI probe. Normal bias behaves similar to the other form of bias and may help reduce self-occlusion. Equivalent to [member GIProbe.normal_bias]. - - - - - - + + + Sets the propagation of light within this GI probe. Equivalent to [member GIProbe.propagation]. - - - - - - + + + Sets the to cell [Transform] for this GI probe. - - + Returns [code]true[/code] if changes have been made to the VisualServer's data. [method draw] is usually called if this happens. - - - - + + Not yet implemented. Always returns [code]false[/code]. - - - - + + Returns [code]true[/code] if the OS supports a certain feature. Features might be [code]s3tc[/code], [code]etc[/code], [code]etc2[/code], [code]pvrtc[/code] and [code]skinning_fallback[/code]. When rendering with GLES2, returns [code]true[/code] with [code]skinning_fallback[/code] in case the hardware doesn't support the default GPU skinning process. - - - - - - - - + + + + Sets up [ImmediateGeometry] internals to prepare for drawing. Equivalent to [method ImmediateGeometry.begin]. - - - - + + Clears everything that was set up between [method immediate_begin] and [method immediate_end]. Equivalent to [method ImmediateGeometry.clear]. - - - - - - + + + Sets the color to be used with next vertex. Equivalent to [method ImmediateGeometry.set_color]. - - + Creates an immediate geometry and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]immediate_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -1726,132 +1229,99 @@ - - - - + + Ends drawing the [ImmediateGeometry] and displays it. Equivalent to [method ImmediateGeometry.end]. - - - - + + Returns the material assigned to the [ImmediateGeometry]. - - - - - - + + + Sets the normal to be used with next vertex. Equivalent to [method ImmediateGeometry.set_normal]. - - - - - - + + + Sets the material to be used to draw the [ImmediateGeometry]. - - - - - - + + + Sets the tangent to be used with next vertex. Equivalent to [method ImmediateGeometry.set_tangent]. - - - - - - + + + Sets the UV to be used with next vertex. Equivalent to [method ImmediateGeometry.set_uv]. - - - - - - + + + Sets the UV2 to be used with next vertex. Equivalent to [method ImmediateGeometry.set_uv2]. - - - - - - + + + Adds the next vertex using the information provided in advance. Equivalent to [method ImmediateGeometry.add_vertex]. - - - - - - + + + Adds the next vertex using the information provided in advance. This is a helper class that calls [method immediate_vertex] under the hood. Equivalent to [method ImmediateGeometry.add_vertex]. - - + Initializes the visual server. This function is called internally by platform-dependent code during engine initialization. If called from a running game, it will not do anything. - - - - - - + + + Attaches a unique Object ID to instance. Object ID must be attached to instance for proper culling with [method instances_cull_aabb], [method instances_cull_convex], and [method instances_cull_ray]. - - - - - - + + + Attaches a skeleton to an instance. Removes the previous skeleton from the instance. - - + Creates a visual instance and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -1859,419 +1329,302 @@ - - - - - - + + + Creates a visual instance, adds it to the VisualServer, and sets both base and scenario. It can be accessed with the RID that is returned. This RID will be used in all [code]instance_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - + + + Not implemented in Godot 3.x. - - - - - - + + + Sets the shadow casting setting to one of [enum ShadowCastingSetting]. Equivalent to [member GeometryInstance.cast_shadow]. - - - - - - - - - - - - + + + + + + Not implemented in Godot 3.x. - - - - - - - - + + + + Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details. - - - - - - + + + Sets a material that will override the material for all surfaces on the mesh associated with this instance. Equivalent to [member GeometryInstance.material_override]. - - - - - - + + + Sets the base of the instance. A base can be any of the 3D objects that are created in the VisualServer that can be displayed. For example, any of the light types, mesh, multimesh, immediate geometry, particle system, reflection probe, lightmap capture, and the GI probe are all types that can be set as the base of an instance in order to be displayed in the scenario. - - - - - - - - + + + + Sets the weight for a given blend shape associated with this instance. - - - - - - + + + Sets a custom AABB to use when culling objects from the view frustum. Equivalent to [method GeometryInstance.set_custom_aabb]. - - - - - - + + + Function not implemented in Godot 3.x. - - - - - - + + + Sets a margin to increase the size of the AABB when culling objects from the view frustum. This allows you to avoid culling objects that fall outside the view frustum. Equivalent to [member GeometryInstance.extra_cull_margin]. - - - - - - + + + Sets the render layers that this instance will be drawn to. Equivalent to [member VisualInstance.layers]. - - - - - - + + + Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in. - - - - - - - - + + + + Sets the material of a specific surface. Equivalent to [method MeshInstance.set_surface_material]. - - - - - - + + + Sets the world space transform of the instance. Equivalent to [member Spatial.transform]. - - - - - - - - - - - - + + + + + + Sets the lightmap to use with this instance. - - - - - - + + + Sets whether an instance is drawn or not. Equivalent to [member Spatial.visible]. - - - - - - + + + Returns an array of object IDs intersecting with the provided AABB. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. - - - - - - + + + Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. - - - - - - - - + + + + Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query. This forces an update for all resources queued to update. [b]Warning:[/b] This function is primarily intended for editor usage. For in-game use cases, prefer physics collision. - - - - - - + + + If [code]true[/code], this directional light will blend between shadow map splits resulting in a smoother transition between them. Equivalent to [member DirectionalLight.directional_shadow_blend_splits]. - - - - - - + + + Sets the shadow depth range mode for this directional light. Equivalent to [member DirectionalLight.directional_shadow_depth_range]. See [enum LightDirectionalShadowDepthRangeMode] for options. - - - - - - + + + Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options. - - - - - - + + + Sets whether to use vertical or horizontal detail for this omni light. This can be used to alleviate artifacts in the shadow map. Equivalent to [member OmniLight.omni_shadow_detail]. - - - - - - + + + Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual paraboloid is faster but may suffer from artifacts. Equivalent to [member OmniLight.omni_shadow_mode]. - - - - - - + + + Sets the bake mode for this light, see [enum LightBakeMode] for options. The bake mode affects how the light will be baked in [BakedLightmap]s and [GIProbe]s. - - - - - - + + + Sets the color of the light. Equivalent to [member Light.light_color]. - - - - - - + + + Sets the cull mask for this Light. Lights only affect objects in the selected layers. Equivalent to [member Light.light_cull_mask]. - - - - - - + + + If [code]true[/code], light will subtract light instead of adding light. Equivalent to [member Light.light_negative]. - - - - - - - - + + + + Sets the specified light parameter. See [enum LightParam] for options. Equivalent to [method Light.set_param]. - - - - - - + + + Not implemented in Godot 3.x. - - - - - - + + + If [code]true[/code], reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double sided shadows with [method instance_geometry_set_cast_shadows_setting]. Equivalent to [member Light.shadow_reverse_cull_face]. - - - - - - + + + If [code]true[/code], light will cast shadows. Equivalent to [member Light.shadow_enabled]. - - - - - - + + + Sets the color of the shadow cast by the light. Equivalent to [member Light.shadow_color]. - - - - - - + + + Sets whether GI probes capture light information from this light. [i]Deprecated method.[/i] Use [method light_set_bake_mode] instead. This method is only kept for compatibility reasons and calls [method light_set_bake_mode] internally, setting the bake mode to [constant LIGHT_BAKE_DISABLED] or [constant LIGHT_BAKE_INDIRECT] depending on the given parameter. - - + Creates a lightmap capture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]lightmap_capture_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -2279,263 +1632,195 @@ - - - - + + Returns the size of the lightmap capture area. - - - - + + Returns the energy multiplier used by the lightmap capture. - - - - + + Returns the octree used by the lightmap capture. - - - - + + Returns the cell subdivision amount used by this lightmap capture's octree. - - - - + + Returns the cell transform for this lightmap capture's octree. - - - - + + Returns [code]true[/code] if capture is in "interior" mode. - - - - - - + + + Sets the size of the area covered by the lightmap capture. Equivalent to [member BakedLightmapData.bounds]. - - - - - - + + + Sets the energy multiplier for this lightmap capture. Equivalent to [member BakedLightmapData.energy]. - - - - - - + + + Sets the "interior" mode for this lightmap capture. Equivalent to [member BakedLightmapData.interior]. - - - - - - + + + Sets the octree to be used by this lightmap capture. This function is normally used by the [BakedLightmap] node. Equivalent to [member BakedLightmapData.octree]. - - - - - - + + + Sets the subdivision level of this lightmap capture's octree. Equivalent to [member BakedLightmapData.cell_subdiv]. - - - - - - + + + Sets the octree cell transform for this lightmap capture's octree. Equivalent to [member BakedLightmapData.cell_space_transform]. - - - - - - - - + + + + Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions. - - + Creates an empty material and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]material_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - + + + Returns the value of a certain material's parameter. - - - - - - + + + Returns the default value for the param if available. Otherwise returns an empty [Variant]. - - - - + + Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader. - - - - - - + + + Sets a material's line width. - - - - - - + + + Sets an object's next material. - - - - - - - - + + + + Sets a material's parameter. - - - - - - + + + Sets a material's render priority. - - - - - - + + + Sets a shader material's shader. - - - - - - - - - - - - + + + + + + Adds a surface generated from the Arrays to a mesh. See [enum PrimitiveType] constants for types. - - - - + + Removes all surfaces from a mesh. - - + Creates a new mesh and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]mesh_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -2543,282 +1828,204 @@ - - - - + + Returns a mesh's blend shape count. - - - - + + Returns a mesh's blend shape mode. - - - - + + Returns a mesh's custom aabb. - - - - + + Returns a mesh's number of surfaces. - - - - - - + + + Removes a mesh's surface. - - - - - - + + + Sets a mesh's blend shape count. - - - - - - + + + Sets a mesh's blend shape mode. - - - - - - + + + Sets a mesh's custom aabb. - - - - - - + + + Returns a mesh's surface's aabb. - - - - - - + + + Returns a mesh's surface's vertex buffer. - - - - - - + + + Returns a mesh's surface's amount of indices. - - - - - - + + + Returns a mesh's surface's amount of vertices. - - - - - - + + + Returns a mesh's surface's buffer arrays. - - - - - - + + + Returns a mesh's surface's arrays for blend shapes. - - - - - - + + + Returns the format of a mesh's surface. - - - - - - - - - - + + + + + Function is unused in Godot 3.x. - - - - - - - - + + + + Function is unused in Godot 3.x. - - - - - - + + + Returns a mesh's surface's index buffer. - - - - - - + + + Returns a mesh's surface's material. - - - - - - + + + Returns the primitive type of a mesh's surface. - - - - - - + + + Returns the aabb of a mesh's surface's skeleton. - - - - - - - - + + + + Sets a mesh's surface's material. - - - - - - - - - - + + + + + Updates a specific region of a vertex buffer for the specified surface. Warning: this function alters the vertex buffer directly with no safety mechanisms, you can easily corrupt your mesh. - - - - - - - - - - - - + + + + + + Allocates space for the multimesh data. Format parameters determine how the data will be stored by OpenGL. See [enum MultimeshTransformFormat], [enum MultimeshColorFormat], and [enum MultimeshCustomDataFormat] for usage. Equivalent to [member MultiMesh.instance_count]. - - + Creates a new multimesh on the VisualServer and returns an [RID] handle. This RID will be used in all [code]multimesh_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -2826,144 +2033,105 @@ - - - - + + Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh. - - - - + + Returns the number of instances allocated for this multimesh. - - - - + + Returns the RID of the mesh that will be used in drawing this multimesh. - - - - + + Returns the number of visible instances for this multimesh. - - - - - - + + + Returns the color by which the specified instance will be modulated. - - - - - - + + + Returns the custom data associated with the specified instance. - - - - - - + + + Returns the [Transform] of the specified instance. - - - - - - + + + Returns the [Transform2D] of the specified instance. For use when the multimesh is set to use 2D transforms. - - - - - - - - + + + + Sets the color by which this instance will be modulated. Equivalent to [method MultiMesh.set_instance_color]. - - - - - - - - + + + + Sets the custom data for this instance. Custom data is passed as a [Color], but is interpreted as a [code]vec4[/code] in the shader. Equivalent to [method MultiMesh.set_instance_custom_data]. - - - - - - - - + + + + Sets the [Transform] for this instance. Equivalent to [method MultiMesh.set_instance_transform]. - - - - - - - - + + + + Sets the [Transform2D] for this instance. For use when multimesh is used in 2D. Equivalent to [method MultiMesh.set_instance_transform_2d]. - - - - - - + + + Sets all data related to the instances in one go. This is especially useful when loading the data from disk or preparing the data from GDNative. @@ -2973,30 +2141,23 @@ - - - - - - + + + Sets the mesh to be drawn by the multimesh. Equivalent to [member MultiMesh.mesh]. - - - - - - + + + Sets the number of instances visible at a given time. If -1, all instances that have been allocated are drawn. Equivalent to [member MultiMesh.visible_instance_count]. - - + Creates a new omni light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -3004,8 +2165,7 @@ - - + Creates a particle system and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]particles_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -3013,242 +2173,179 @@ - - - - + + Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to [method Particles.capture_aabb]. - - - - + + Returns [code]true[/code] if particles are currently set to emitting. - - - - + + Returns [code]true[/code] if particles are not emitting and particles are set to inactive. - - - - + + Add particle system to list of particle systems that need to be updated. Update will take place on the next frame, or on the next call to [method instances_cull_aabb], [method instances_cull_convex], or [method instances_cull_ray]. - - - - + + Reset the particles on the next update. Equivalent to [method Particles.restart]. - - - - - - + + + Sets the number of particles to be drawn and allocates the memory for them. Equivalent to [member Particles.amount]. - - - - - - + + + Sets a custom axis-aligned bounding box for the particle system. Equivalent to [member Particles.visibility_aabb]. - - - - - - + + + Sets the draw order of the particles to one of the named enums from [enum ParticlesDrawOrder]. See [enum ParticlesDrawOrder] for options. Equivalent to [member Particles.draw_order]. - - - - - - - - + + + + Sets the mesh to be used for the specified draw pass. Equivalent to [member Particles.draw_pass_1], [member Particles.draw_pass_2], [member Particles.draw_pass_3], and [member Particles.draw_pass_4]. - - - - - - + + + Sets the number of draw passes to use. Equivalent to [member Particles.draw_passes]. - - - - - - + + + Sets the [Transform] that will be used by the particles when they first emit. - - - - - - + + + If [code]true[/code], particles will emit over time. Setting to false does not reset the particles, but only stops their emission. Equivalent to [member Particles.emitting]. - - - - - - + + + Sets the explosiveness ratio. Equivalent to [member Particles.explosiveness]. - - - - - - + + + Sets the frame rate that the particle system rendering will be fixed to. Equivalent to [member Particles.fixed_fps]. - - - - - - + + + If [code]true[/code], uses fractional delta which smooths the movement of the particles. Equivalent to [member Particles.fract_delta]. - - - - - - + + + Sets the lifetime of each particle in the system. Equivalent to [member Particles.lifetime]. - - - - - - + + + If [code]true[/code], particles will emit once and then stop. Equivalent to [member Particles.one_shot]. - - - - - - + + + Sets the preprocess time for the particles' animation. This lets you delay starting an animation until after the particles have begun emitting. Equivalent to [member Particles.preprocess]. - - - - - - + + + Sets the material for processing the particles. Note: this is not the material used to draw the materials. Equivalent to [member Particles.process_material]. - - - - - - + + + Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to [member Particles.randomness]. - - - - - - + + + Sets the speed scale of the particle system. Equivalent to [member Particles.speed_scale]. - - - - - - + + + If [code]true[/code], particles use local coordinates. If [code]false[/code] they use global coordinates. Equivalent to [member Particles.local_coords]. - - + Creates a reflection probe and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]reflection_probe_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -3256,154 +2353,113 @@ - - - - - - + + + If [code]true[/code], reflections will ignore sky contribution. Equivalent to [member ReflectionProbe.interior_enable]. - - - - - - + + + Sets the render cull mask for this reflection probe. Only instances with a matching cull mask will be rendered by this probe. Equivalent to [member ReflectionProbe.cull_mask]. - - - - - - + + + If [code]true[/code], uses box projection. This can make reflections look more correct in certain situations. Equivalent to [member ReflectionProbe.box_projection]. - - - - - - + + + If [code]true[/code], computes shadows in the reflection probe. This makes the reflection much slower to compute. Equivalent to [member ReflectionProbe.enable_shadows]. - - - - - - + + + Sets the size of the area that the reflection probe will capture. Equivalent to [member ReflectionProbe.extents]. - - - - - - + + + Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to [member ReflectionProbe.intensity]. - - - - - - + + + Sets the ambient light color for this reflection probe when set to interior mode. Equivalent to [member ReflectionProbe.interior_ambient_color]. - - - - - - + + + Sets the energy multiplier for this reflection probes ambient light contribution when set to interior mode. Equivalent to [member ReflectionProbe.interior_ambient_energy]. - - - - - - + + + Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to interior mode. Useful so that ambient light matches the color of the room. Equivalent to [member ReflectionProbe.interior_ambient_contrib]. - - - - - - + + + Sets the max distance away from the probe an object can be before it is culled. Equivalent to [member ReflectionProbe.max_distance]. - - - - - - + + + Sets the origin offset to be used when this reflection probe is in box project mode. Equivalent to [member ReflectionProbe.origin_offset]. - - - - - - + + + Sets how often the reflection probe updates. Can either be once or every frame. See [enum ReflectionProbeUpdateMode] for options. - - - - - - - - + + + + Schedules a callback to the corresponding named [code]method[/code] on [code]where[/code] after a frame has been drawn. The callback method must use only 1 argument which will be called with [code]userdata[/code]. - - + Creates a scenario and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]scenario_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -3411,257 +2467,191 @@ - - - - - - + + + Sets the [enum ScenarioDebugMode] for this scenario. See [enum ScenarioDebugMode] for options. - - - - - - + + + Sets the environment that will be used with this scenario. - - - - - - + + + Sets the fallback environment to be used by this scenario. The fallback environment is used if no environment is set. Internally, this is used by the editor to provide a default environment. - - - - - - - - + + + + Sets the size of the reflection atlas shared by all reflection probes in this scenario. - - - - - - - - - - + + + + + Sets a boot image. The color defines the background color. If [code]scale[/code] is [code]true[/code], the image will be scaled to fit the screen size. If [code]use_filter[/code] is [code]true[/code], the image will be scaled with linear interpolation. If [code]use_filter[/code] is [code]false[/code], the image will be scaled with nearest-neighbor interpolation. - - - - + + If [code]true[/code], the engine will generate wireframes for use with the wireframe debug mode. - - - - + + Sets the default clear color which is used when a specific clear color has not been selected. - - - - + + Sets the scale to apply to the passage of time for the shaders' [code]TIME[/code] builtin. The default value is [code]1.0[/code], which means [code]TIME[/code] will count the real time as it goes by, without narrowing or stretching it. - - + Creates an empty shader and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]shader_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - + + Returns a shader's code. - - - - - - + + + Returns a default texture from a shader searched by name. - - - - + + Returns the parameters of a shader. - - - - - - + + + Sets a shader's code. - - - - - - - - + + + + Sets a shader's default texture. Overwrites the texture given by name. - - - - - - - - + + + + Allocates the GPU buffers for this skeleton. - - - - - - + + + Returns the [Transform] set for a specific bone of this skeleton. - - - - - - + + + Returns the [Transform2D] set for a specific bone of this skeleton. - - - - - - - - + + + + Sets the [Transform] for a specific bone of this skeleton. - - - - - - - - + + + + Sets the [Transform2D] for a specific bone of this skeleton. - - + Creates a skeleton and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]skeleton_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - + + Returns the number of bones allocated for this skeleton. - - + Creates an empty sky and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]sky_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - - - + + + + Sets a sky's texture. - - + Creates a spot light and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID can be used in most [code]light_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. @@ -3669,279 +2659,203 @@ - - + Not implemented in Godot 3.x. - - - - - - - - - - - - - - - - + + + + + + + + Allocates the GPU memory for the texture. - - - - - - + + + Binds the texture to a texture slot. - - + Creates an empty texture and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]texture_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - - - + + + Creates a texture, allocates the space for an image, and fills in the image. - - + Returns a list of all the textures and their information. - - - - - - + + + Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the [RID] of the image at one of the cubes sides. - - - - + + Returns the depth of the texture. - - - - + + Returns the flags of a texture. - - - - + + Returns the format of the texture's image. - - - - + + Returns the texture's height. - - - - + + Returns the texture's path. - - - - + + Returns the opengl id of the texture's image. - - - - + + Returns the type of the texture, can be any of the [enum TextureType]. - - - - + + Returns the texture's width. - - - - - - - - + + + + Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + Sets a part of the data for a texture. Warning: this function calls the underlying graphics API directly and may corrupt your texture if used improperly. - - - - - - + + + Sets the texture's flags. See [enum TextureFlags] for options. - - - - - - + + + Sets the texture's path. - - - - + + If [code]true[/code], sets internal processes to shrink all image data to half the size. - - - - - - - - - - + + + + + Resizes the texture to the specified dimensions. - - - - + + If [code]true[/code], the image will be stored in the texture's images array if overwritten. - - - - - - + + + Sets a viewport's camera. - - - - - - + + + Sets a viewport's canvas. - - - - - - - - + + + + Copies viewport to a region of the screen specified by [code]rect[/code]. If [member Viewport.render_direct_to_screen] is [code]true[/code], then viewport does not use a framebuffer and the contents of the viewport are rendered directly to screen. However, note that the root viewport is drawn last, therefore it will draw over the screen. Accordingly, you must set the root viewport to an area that does not cover the area that you have attached this viewport to. For example, you can set the root viewport to not render at all with the following code: @@ -3954,337 +2868,246 @@ - - + Creates an empty viewport and adds it to the VisualServer. It can be accessed with the RID that is returned. This RID will be used in all [code]viewport_*[/code] VisualServer functions. Once finished with your RID, you will want to free the RID using the VisualServer's [method free_rid] static method. - - - - + + Detaches the viewport from the screen. - - - - - - + + + Returns a viewport's render information. For options, see the [enum ViewportRenderInfo] constants. - - - - + + Returns the viewport's last rendered frame. - - - - - - + + + Detaches a viewport from a canvas and vice versa. - - - - - - + + + If [code]true[/code], sets the viewport active, else sets it inactive. - - - - - - - - - - + + + + + Sets the stacking order for a viewport's canvas. [code]layer[/code] is the actual canvas layer, while [code]sublayer[/code] specifies the stacking order of the canvas among those in the same layer. - - - - - - - - + + + + Sets the transformation of a viewport's canvas. - - - - - - + + + Sets the clear mode of a viewport. See [enum ViewportClearMode] for options. - - - - - - + + + Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options. - - - - - - + + + If [code]true[/code], a viewport's 3D rendering is disabled. - - - - - - + + + If [code]true[/code], rendering of a viewport's environment is disabled. - - - - - - + + + Sets the viewport's global transformation matrix. - - - - - - + + + If [code]true[/code], the viewport renders to hdr. - - - - - - + + + If [code]true[/code], the viewport's canvas is not rendered. - - - - - - + + + Currently unimplemented in Godot 3.x. - - - - - - + + + Sets the anti-aliasing mode. See [enum ViewportMSAA] for options. - - - - - - + + + Sets the viewport's parent to another viewport. - - - - - - + + + If [code]true[/code], render the contents of the viewport directly to screen. This allows a low-level optimization where you can skip drawing a viewport to the root viewport. While this optimization can result in a significant increase in speed (especially on older devices), it comes at a cost of usability. When this is enabled, you cannot read from the viewport or from the [code]SCREEN_TEXTURE[/code]. You also lose the benefit of certain window settings, such as the various stretch modes. Another consequence to be aware of is that in 2D the rendering happens in window coordinates, so if you have a viewport that is double the size of the window, and you set this, then only the portion that fits within the window will be drawn, no automatic scaling is possible, even if your game scene is significantly larger than the window size. - - - - - - + + + Sets a viewport's scenario. The scenario contains information about the [enum ScenarioDebugMode], environment information, reflection atlas etc. - - - - - - - - + + + + Sets the shadow atlas quadrant's subdivision. - - - - - - + + + Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2. - - - - - - - - + + + + Sets the viewport's width and height. - - - - - - + + + If [code]true[/code], the viewport renders its background as transparent. - - - - - - + + + Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options. - - - - - - + + + Sets the viewport's 2D/3D mode. See [enum ViewportUsage] constants for options. - - - - - - + + + If [code]true[/code], the viewport uses augmented or virtual reality technologies. See [ARVRInterface]. - - - - - - + + + If [code]true[/code], uses a fast post-processing filter to make banding significantly less visible. In some cases, debanding may introduce a slightly noticeable dithering pattern. It's recommended to enable debanding only when actually needed since the dithering pattern will make lossless-compressed screenshots larger. [b]Note:[/b] Only available on the GLES3 backend. [member Viewport.hdr] must also be [code]true[/code] for debanding to be effective. - - - - - - + + + Enables fast approximate antialiasing for this viewport. FXAA is a popular screen-space antialiasing method, which is fast but will make the image look blurry, especially at lower resolutions. It can still work relatively well at large resolutions such as 1440p and 4K. - - - - - - + + + If [code]true[/code], the viewport's rendering is flipped vertically. diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index b3d3c4214e4..a6ea51a6f25 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -11,182 +11,126 @@ - - - - - - - - - - + + + + + Adds the specified node to the shader. - - - - - - - - - - - - + + + + + + Returns [code]true[/code] if the specified nodes and ports can be connected together. - - - - - - - - - - - - + + + + + + Connects the specified nodes and ports. - - - - - - - - - - - - + + + + + + Connects the specified nodes and ports, even if they can't be connected. Such connection is invalid and will not function properly. - - - - - - - - - - - - + + + + + + Connects the specified nodes and ports. - - - - - - + + + Returns the shader node instance with specified [code]type[/code] and [code]id[/code]. - - - - + + Returns the list of connected nodes with the specified type. - - - - + + Returns the list of all nodes in the shader with the specified type. - - - - - - + + + Returns the position of the specified node within the shader graph. - - - - + + - - - - - - - - - - - - + + + + + + Returns [code]true[/code] if the specified node and port connection exist. - - - - - - + + + Removes the specified node from the shader. - - - - + + Sets the mode of this shader. - - - - - - - - + + + + Sets the position of the specified node. diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index 0878d411d70..a1a87265deb 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -10,37 +10,29 @@ - - + Returns an [Array] containing default values for all of the input ports of the node in the form [code][index0, value0, index1, value1, ...][/code]. - - - - + + Returns the default value of the input [code]port[/code]. - - - - + + Sets the default input ports values using an [Array] of the form [code][index0, value0, index1, value1, ...][/code]. For example: [code][0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)][/code]. - - - - - - + + + Sets the default value for the selected input [code]port[/code]. diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml index d1eecad1eaa..15c4d2841f5 100644 --- a/doc/classes/VisualShaderNodeCustom.xml +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -17,24 +17,18 @@ - - + Override this method to define the category of the associated custom node in the Visual Shader Editor's members dialog. The path may look like [code]"MyGame/MyFunctions/Noise"[/code]. Defining this method is [b]optional[/b]. If not overridden, the node will be filed under the "Custom" category. - - - - - - - - - - + + + + + Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). The [code]input_vars[/code] and [code]output_vars[/code] arrays contain the string names of the various input and output variables, as defined by [code]_get_input_*[/code] and [code]_get_output_*[/code] virtual methods in this class. @@ -44,18 +38,15 @@ - - + Override this method to define the description of the associated custom node in the Visual Shader Editor's members dialog. Defining this method is [b]optional[/b]. - - - - + + Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). Be careful with this functionality as it can cause name conflicts with other custom nodes, so be sure to give the defined entities unique names. @@ -64,80 +55,67 @@ - - + Override this method to define the amount of input ports of the associated custom node. Defining this method is [b]required[/b]. If not overridden, the node has no input ports. - - - - + + Override this method to define the names of input ports of the associated custom node. The names are used both for the input slots in the editor and as identifiers in the shader code, and are passed in the [code]input_vars[/code] array in [method _get_code]. Defining this method is [b]optional[/b], but recommended. If not overridden, input ports are named as [code]"in" + str(port)[/code]. - - - - + + Override this method to define the returned type of each input port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). Defining this method is [b]optional[/b], but recommended. If not overridden, input ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. - - + Override this method to define the name of the associated custom node in the Visual Shader Editor's members dialog and graph. Defining this method is [b]optional[/b], but recommended. If not overridden, the node will be named as "Unnamed". - - + Override this method to define the amount of output ports of the associated custom node. Defining this method is [b]required[/b]. If not overridden, the node has no output ports. - - - - + + Override this method to define the names of output ports of the associated custom node. The names are used both for the output slots in the editor and as identifiers in the shader code, and are passed in the [code]output_vars[/code] array in [method _get_code]. Defining this method is [b]optional[/b], but recommended. If not overridden, output ports are named as [code]"out" + str(port)[/code]. - - - - + + Override this method to define the returned type of each output port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). Defining this method is [b]optional[/b], but recommended. If not overridden, output ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. - - + Override this method to define the return icon of the associated custom node in the Visual Shader Editor's members dialog. Defining this method is [b]optional[/b]. If not overridden, no return icon is shown. - - + Override this method to define the subcategory of the associated custom node in the Visual Shader Editor's members dialog. Defining this method is [b]optional[/b]. If not overridden, the node will be filed under the root of the main category (see [method _get_category]). diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml index 6858adf487f..a1dbe7c5a48 100644 --- a/doc/classes/VisualShaderNodeGroupBase.xml +++ b/doc/classes/VisualShaderNodeGroupBase.xml @@ -10,190 +10,148 @@ - - - - - - - - + + + + Adds an input port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code]. - - - - - - - - + + + + Adds an output port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code]. - - + Removes all previously specified input ports. - - + Removes all previously specified output ports. - - + Returns a free input port ID which can be used in [method add_input_port]. - - + Returns a free output port ID which can be used in [method add_output_port]. - - + Returns the number of input ports in use. Alternative for [method get_free_input_port_id]. - - + Returns a [String] description of the input ports as a colon-separated list using the format [code]id,type,name;[/code] (see [method add_input_port]). - - + Returns the number of output ports in use. Alternative for [method get_free_output_port_id]. - - + Returns a [String] description of the output ports as a colon-separated list using the format [code]id,type,name;[/code] (see [method add_output_port]). - - - - + + Returns [code]true[/code] if the specified input port exists. - - - - + + Returns [code]true[/code] if the specified output port exists. - - - - + + Returns [code]true[/code] if the specified port name does not override an existed port name and is valid within the shader. - - - - + + Removes the specified input port. - - - - + + Removes the specified output port. - - - - - - + + + Renames the specified input port. - - - - - - + + + Sets the specified input port's type (see [enum VisualShaderNode.PortType]). - - - - + + Defines all input ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_input_port]). - - - - - - + + + Renames the specified output port. - - - - - - + + + Sets the specified output port's type (see [enum VisualShaderNode.PortType]). - - - - + + Defines all output ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_output_port]). diff --git a/doc/classes/VisualShaderNodeInput.xml b/doc/classes/VisualShaderNodeInput.xml index fc405b1d78a..7e0f33cbd69 100644 --- a/doc/classes/VisualShaderNodeInput.xml +++ b/doc/classes/VisualShaderNodeInput.xml @@ -10,8 +10,7 @@ - - + diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml index 32635420290..7fc35059285 100644 --- a/doc/classes/WeakRef.xml +++ b/doc/classes/WeakRef.xml @@ -10,8 +10,7 @@ - - + Returns the [Object] this weakref is referring to. diff --git a/doc/classes/WindowDialog.xml b/doc/classes/WindowDialog.xml index 18818e14055..66f76836016 100644 --- a/doc/classes/WindowDialog.xml +++ b/doc/classes/WindowDialog.xml @@ -10,8 +10,7 @@ - - + Returns the close [TextureButton]. diff --git a/doc/classes/X509Certificate.xml b/doc/classes/X509Certificate.xml index f810cfdb357..888ad1ce526 100644 --- a/doc/classes/X509Certificate.xml +++ b/doc/classes/X509Certificate.xml @@ -12,19 +12,15 @@ - - - - + + Loads a certificate from [code]path[/code] ("*.crt" file). - - - - + + Saves a certificate to the given [code]path[/code] (should be a "*.crt" file). diff --git a/doc/classes/XMLParser.xml b/doc/classes/XMLParser.xml index 797101e6b0f..79ec330e62c 100644 --- a/doc/classes/XMLParser.xml +++ b/doc/classes/XMLParser.xml @@ -10,136 +10,111 @@ - - + Gets the amount of attributes in the current element. - - - - + + Gets the name of the attribute specified by the index in [code]idx[/code] argument. - - - - + + Gets the value of the attribute specified by the index in [code]idx[/code] argument. - - + Gets the current line in the parsed file (currently not implemented). - - - - + + Gets the value of a certain attribute of the current element by name. This will raise an error if the element has no such attribute. - - - - + + Gets the value of a certain attribute of the current element by name. This will return an empty [String] if the attribute is not found. - - + Gets the contents of a text node. This will raise an error in any other type of node. - - + Gets the name of the current element node. This will raise an error if the current node type is neither [constant NODE_ELEMENT] nor [constant NODE_ELEMENT_END]. - - + Gets the byte offset of the current node since the beginning of the file or buffer. - - + Gets the type of the current node. Compare with [enum NodeType] constants. - - - - + + Check whether the current element has a certain attribute. - - + Check whether the current element is empty (this only works for completely empty tags, e.g. [code]<element \>[/code]). - - - - + + Opens an XML file for parsing. This returns an error code. - - - - + + Opens an XML raw buffer for parsing. This returns an error code. - - + Reads the next node of the file. This returns an error code. - - - - + + Moves the buffer cursor to a certain offset (since the beginning) and read the next node there. This returns an error code. - - + Skips the current section. If the node contains other elements, they will be ignored and the cursor will go to the closing of the current element. diff --git a/doc/classes/bool.xml b/doc/classes/bool.xml index 61589afe669..c1474232e1b 100644 --- a/doc/classes/bool.xml +++ b/doc/classes/bool.xml @@ -41,28 +41,22 @@ - - - - + + Cast an [int] value to a boolean value, this method will return [code]false[/code] if [code]0[/code] is passed in, and [code]true[/code] for all other ints. - - - - + + Cast a [float] value to a boolean value, this method will return [code]false[/code] if [code]0.0[/code] is passed in, and [code]true[/code] for all other floats. - - - - + + Cast a [String] value to a boolean value, this method will return [code]false[/code] if [code]""[/code] is passed in, and [code]true[/code] for all non-empty strings. Examples: [code]bool("False")[/code] returns [code]true[/code], [code]bool("")[/code] returns [code]false[/code]. diff --git a/doc/classes/float.xml b/doc/classes/float.xml index de65d55db49..d62feb0bfff 100644 --- a/doc/classes/float.xml +++ b/doc/classes/float.xml @@ -10,28 +10,22 @@ - - - - + + Cast a [bool] value to a floating-point value, [code]float(true)[/code] will be equal to 1.0 and [code]float(false)[/code] will be equal to 0.0. - - - - + + Cast an [int] value to a floating-point value, [code]float(1)[/code] will be equal to 1.0. - - - - + + Cast a [String] value to a floating-point value. This method accepts float value strings like [code]"1.23"[/code] and exponential notation strings for its parameter so calling [code]float("1e3")[/code] will return 1000.0 and calling [code]float("1e-3")[/code] will return 0.001. Calling this method with an invalid float string will return 0. This method stops parsing at the first invalid character and will return the parsed result so far, so calling [code]float("1a3")[/code] will return 1 while calling [code]float("1e3a2")[/code] will return 1000.0. diff --git a/doc/classes/int.xml b/doc/classes/int.xml index 904843d39e8..d65428fc905 100644 --- a/doc/classes/int.xml +++ b/doc/classes/int.xml @@ -24,28 +24,22 @@ - - - - + + Cast a [bool] value to an integer value, [code]int(true)[/code] will be equals to 1 and [code]int(false)[/code] will be equals to 0. - - - - + + Cast a float value to an integer value, this method simply removes the number fractions (i.e. rounds [code]from[/code] towards zero), so for example [code]int(2.7)[/code] will be equals to 2, [code]int(0.1)[/code] will be equals to 0 and [code]int(-2.7)[/code] will be equals to -2. This operation is also called truncation. - - - - + + Cast a [String] value to an integer value, this method is an integer parser from a string, so calling this method with an invalid integer string will return 0, a valid string will be something like [code]'1.7'[/code]. This method will ignore all non-number characters, so calling [code]int('1e3')[/code] will return 13. diff --git a/editor/doc/doc_data.cpp b/editor/doc/doc_data.cpp index 99c3f41a5cc..b698a44a3e5 100644 --- a/editor/doc/doc_data.cpp +++ b/editor/doc/doc_data.cpp @@ -1091,8 +1091,7 @@ Error DocData::save_classes(const String &p_default_path, const Map"); - _write_string(f, 3, ""); + _write_string(f, 3, ""); } for (int j = 0; j < m.arguments.size(); j++) { @@ -1105,11 +1104,9 @@ Error DocData::save_classes(const String &p_default_path, const Map"); + _write_string(f, 3, ""); else - _write_string(f, 3, ""); - - _write_string(f, 3, ""); + _write_string(f, 3, ""); } _write_string(f, 3, ""); @@ -1161,8 +1158,7 @@ Error DocData::save_classes(const String &p_default_path, const Map"); - _write_string(f, 3, ""); + _write_string(f, 3, ""); } _write_string(f, 3, ""); diff --git a/modules/csg/doc_classes/CSGShape.xml b/modules/csg/doc_classes/CSGShape.xml index 53e9910200d..02f279d4560 100644 --- a/modules/csg/doc_classes/CSGShape.xml +++ b/modules/csg/doc_classes/CSGShape.xml @@ -10,55 +10,43 @@ - - - - + + Returns an individual bit on the collision mask. - - - - + + Returns an individual bit on the collision mask. - - + Returns an [Array] with two elements, the first is the [Transform] of this node and the second is the root [Mesh] of this node. Only works when this node is the root shape. - - + Returns [code]true[/code] if this is a root shape and is thus the object that is rendered. - - - - - - + + + Sets individual bits on the layer mask. Use this if you only need to change one layer's value. - - - - - - + + + Sets individual bits on the collision mask. Use this if you only need to change one layer's value. diff --git a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml index 3f0a11d433c..a82578bdec8 100644 --- a/modules/enet/doc_classes/NetworkedMultiplayerENet.xml +++ b/modules/enet/doc_classes/NetworkedMultiplayerENet.xml @@ -14,127 +14,94 @@ - - - - + + Closes the connection. Ignored if no connection is currently established. If this is a server it tries to notify all clients before forcibly disconnecting them. If this is a client it simply closes the connection to the server. - - - - - - - - - - - - + + + + + + Create client that connects to a server at [code]address[/code] using specified [code]port[/code]. The given address needs to be either a fully qualified domain name (e.g. [code]"www.example.com"[/code]) or an IP address in IPv4 or IPv6 format (e.g. [code]"192.168.1.1"[/code]). The [code]port[/code] is the port the server is listening on. The [code]in_bandwidth[/code] and [code]out_bandwidth[/code] parameters can be used to limit the incoming and outgoing bandwidth to the given number of bytes per second. The default of 0 means unlimited bandwidth. Note that ENet will strategically drop packets on specific sides of a connection between peers to ensure the peer's bandwidth is not overwhelmed. The bandwidth parameters also determine the window size of a connection which limits the amount of reliable packets that may be in transit at any given time. Returns [constant OK] if a client was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerENet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the client could not be created. If [code]client_port[/code] is specified, the client will also listen to the given port; this is useful for some NAT traversal techniques. - - - - - - - - - - + + + + + Create server that listens to connections via [code]port[/code]. The port needs to be an available, unused port between 0 and 65535. Note that ports below 1024 are privileged and may require elevated permissions depending on the platform. To change the interface the server listens on, use [method set_bind_ip]. The default IP is the wildcard [code]"*"[/code], which listens on all available interfaces. [code]max_clients[/code] is the maximum number of clients that are allowed at once, any number up to 4095 may be used, although the achievable number of simultaneous clients may be far lower and depends on the application. For additional details on the bandwidth parameters, see [method create_client]. Returns [constant OK] if a server was created, [constant ERR_ALREADY_IN_USE] if this NetworkedMultiplayerENet instance already has an open connection (in which case you need to call [method close_connection] first) or [constant ERR_CANT_CREATE] if the server could not be created. - - - - - - + + + Disconnect the given peer. If "now" is set to [code]true[/code], the connection will be closed immediately without flushing queued messages. - - + Returns the channel of the last packet fetched via [method PacketPeer.get_packet]. - - + Returns the channel of the next packet that will be retrieved via [method PacketPeer.get_packet]. - - - - + + Returns the IP address of the given peer. - - - - + + Returns the remote port of the given peer. - - - - + + The IP used when creating a server. This is set to the wildcard [code]"*"[/code] by default, which binds to all available interfaces. The given IP needs to be in IPv4 or IPv6 address format, for example: [code]"192.168.1.1"[/code]. - - - - + + Configure the [X509Certificate] to use when [member use_dtls] is [code]true[/code]. For servers, you must also setup the [CryptoKey] via [method set_dtls_key]. - - - - + + Configure the [CryptoKey] to use when [member use_dtls] is [code]true[/code]. Remember to also call [method set_dtls_certificate] to setup your [X509Certificate]. - - - - - - - - - - + + + + + Sets the timeout parameters for a peer. The timeout parameters control how and when a peer will timeout from a failure to acknowledge reliable traffic. Timeout values are expressed in milliseconds. The [code]timeout_limit[/code] is a factor that, multiplied by a value based on the average round trip time, will determine the timeout limit for a reliable packet. When that limit is reached, the timeout will be doubled, and the peer will be disconnected if that limit has reached [code]timeout_min[/code]. The [code]timeout_max[/code] parameter, on the other hand, defines a fixed timeout for which any packet must be acknowledged or the peer will be dropped. diff --git a/modules/gdnative/doc_classes/GDNative.xml b/modules/gdnative/doc_classes/GDNative.xml index da76e645ac3..63a00792d3f 100644 --- a/modules/gdnative/doc_classes/GDNative.xml +++ b/modules/gdnative/doc_classes/GDNative.xml @@ -8,26 +8,20 @@ - - - - - - - - + + + + - - + - - + diff --git a/modules/gdnative/doc_classes/GDNativeLibrary.xml b/modules/gdnative/doc_classes/GDNativeLibrary.xml index 53d24ef0e6c..7d7b7470524 100644 --- a/modules/gdnative/doc_classes/GDNativeLibrary.xml +++ b/modules/gdnative/doc_classes/GDNativeLibrary.xml @@ -12,15 +12,13 @@ - - + Returns paths to all dependency libraries for the current platform and architecture. - - + Returns the path to the dynamic library file for the current platform and architecture. diff --git a/modules/gdnative/doc_classes/NativeScript.xml b/modules/gdnative/doc_classes/NativeScript.xml index 683a1b77d19..53e525910c0 100644 --- a/modules/gdnative/doc_classes/NativeScript.xml +++ b/modules/gdnative/doc_classes/NativeScript.xml @@ -8,42 +8,34 @@ - - + Returns the documentation string that was previously set with [code]godot_nativescript_set_class_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_method_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_property_documentation[/code]. - - - - + + Returns the documentation string that was previously set with [code]godot_nativescript_set_signal_documentation[/code]. - - + Constructs a new object of the base type with a script of this type already attached. [i]Note[/i]: Any arguments passed to this function will be ignored and not passed to the native constructor function. This will change with in a future API extension. diff --git a/modules/gdnative/doc_classes/PluginScript.xml b/modules/gdnative/doc_classes/PluginScript.xml index d16e4c17f3d..010ea347a2a 100644 --- a/modules/gdnative/doc_classes/PluginScript.xml +++ b/modules/gdnative/doc_classes/PluginScript.xml @@ -8,8 +8,7 @@ - - + Returns a new instance of the script. diff --git a/modules/gdnative/doc_classes/VideoStreamGDNative.xml b/modules/gdnative/doc_classes/VideoStreamGDNative.xml index 6083eb29ff5..c1cd2942c91 100644 --- a/modules/gdnative/doc_classes/VideoStreamGDNative.xml +++ b/modules/gdnative/doc_classes/VideoStreamGDNative.xml @@ -11,17 +11,14 @@ - - + Returns the video file handled by this [VideoStreamGDNative]. - - - - + + Sets the video file that this [VideoStreamGDNative] resource handles. The supported extensions depend on the GDNative plugins used to expose video formats. diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml index c4e3cd066a2..33f3ab97e71 100644 --- a/modules/gdscript/doc_classes/@GDScript.xml +++ b/modules/gdscript/doc_classes/@GDScript.xml @@ -10,16 +10,11 @@ - - - - - - - - - - + + + + + Returns a color constructed from integer red, green, blue, and alpha channels. Each channel should have 8 bits of information ranging from 0 to 255. [code]r8[/code] red channel @@ -32,12 +27,9 @@ - - - - - - + + + Returns a color according to the standardized [code]name[/code] with [code]alpha[/code] ranging from 0 to 1. [codeblock] @@ -47,10 +39,8 @@ - - - - + + Returns the absolute value of parameter [code]s[/code] (i.e. positive value). [codeblock] @@ -59,10 +49,8 @@ - - - - + + Returns the arc cosine of [code]s[/code] in radians. Use to get the angle of cosine [code]s[/code]. [code]s[/code] must be between [code]-1.0[/code] and [code]1.0[/code] (inclusive), otherwise, [method acos] will return [constant NAN]. [codeblock] @@ -72,10 +60,8 @@ - - - - + + Returns the arc sine of [code]s[/code] in radians. Use to get the angle of sine [code]s[/code]. [code]s[/code] must be between [code]-1.0[/code] and [code]1.0[/code] (inclusive), otherwise, [method asin] will return [constant NAN]. [codeblock] @@ -85,12 +71,9 @@ - - - - - - + + + Asserts that the [code]condition[/code] is [code]true[/code]. If the [code]condition[/code] is [code]false[/code], an error is generated. When running from the editor, the running project will also be paused until you resume it. This can be used as a stronger form of [method push_error] for reporting errors to project developers or add-on users. [b]Note:[/b] For performance reasons, the code inside [method assert] is only executed in debug builds or when running the project from the editor. Don't include code that has side effects in an [method assert] call. Otherwise, the project will behave differently when exported in release mode. @@ -106,10 +89,8 @@ - - - - + + Returns the arc tangent of [code]s[/code] in radians. Use it to get the angle from an angle's tangent in trigonometry: [code]atan(tan(angle)) == angle[/code]. The method cannot know in which quadrant the angle should fall. See [method atan2] if you have both [code]y[/code] and [code]x[/code]. @@ -119,12 +100,9 @@ - - - - - - + + + Returns the arc tangent of [code]y/x[/code] in radians. Use to get the angle of tangent [code]y/x[/code]. To compute the value, the method takes into account the sign of both arguments in order to determine the quadrant. Important note: The Y coordinate comes first, by convention. @@ -134,33 +112,25 @@ - - - - - - + + + Decodes a byte array back to a value. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). - - - - - - + + + Converts a 2D point expressed in the cartesian coordinate system (X and Y axis) to the polar coordinate system (a distance from the origin and an angle). - - - - + + Rounds [code]s[/code] upward (towards positive infinity), returning the smallest whole number that is not less than [code]s[/code]. [codeblock] @@ -171,10 +141,8 @@ - - - - + + Returns a character as a String of the given Unicode code point (which is compatible with ASCII code). [codeblock] @@ -186,14 +154,10 @@ - - - - - - - - + + + + Clamps [code]value[/code] and returns a value not less than [code]min[/code] and not more than [code]max[/code]. [codeblock] @@ -204,12 +168,9 @@ - - - - - - + + + Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the [enum Variant.Type] values. [codeblock] @@ -223,10 +184,8 @@ - - - - + + Returns the cosine of angle [code]s[/code] in radians. [codeblock] @@ -236,10 +195,8 @@ - - - - + + Returns the hyperbolic cosine of [code]s[/code] in radians. [codeblock] @@ -248,32 +205,24 @@ - - - - + + Converts from decibels to linear energy (audio). - - - - + + Deprecated alias for [method step_decimals]. - - - - - - - - + + + + Returns the result of [code]value[/code] decreased by [code]step[/code] * [code]amount[/code]. [codeblock] @@ -282,10 +231,8 @@ - - - - + + Converts an angle expressed in degrees to radians. [codeblock] @@ -294,30 +241,23 @@ - - - - + + Converts a dictionary (previously created with [method inst2dict]) back to an instance. Useful for deserializing. - - - - - - + + + Easing function, based on exponent. The curve values are: 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in. - - - - + + The natural exponential function. It raises the mathematical constant [b]e[/b] to the power of [code]s[/code] and returns it. [b]e[/b] has an approximate value of 2.71828, and can be obtained with [code]exp(1)[/code]. @@ -328,10 +268,8 @@ - - - - + + Rounds [code]s[/code] downward (towards negative infinity), returning the largest whole number that is not more than [code]s[/code]. [codeblock] @@ -344,12 +282,9 @@ - - - - - - + + + Returns the floating-point remainder of [code]a/b[/code], keeping the sign of [code]a[/code]. [codeblock] @@ -359,12 +294,9 @@ - - - - - - + + + Returns the floating-point modulus of [code]a/b[/code] that wraps equally in positive and negative. [codeblock] @@ -385,12 +317,9 @@ - - - - - - + + + Returns a reference to the specified function [code]funcname[/code] in the [code]instance[/code] node. As functions aren't first-class objects in GDscript, use [code]funcref[/code] to store a [FuncRef] in a variable and call it later. [codeblock] @@ -403,8 +332,7 @@ - - + Returns an array of dictionaries representing the current call stack. [codeblock] @@ -424,10 +352,8 @@ - - - - + + Returns the integer hash of the variable passed. [codeblock] @@ -436,10 +362,8 @@ - - - - + + Returns the passed instance converted to a dictionary (useful for serializing). [codeblock] @@ -457,10 +381,8 @@ - - - - + + Returns the Object that corresponds to [code]instance_id[/code]. All Objects have a unique instance ID. [codeblock] @@ -473,14 +395,10 @@ - - - - - - - - + + + + Returns a normalized value considering the given range. This is the opposite of [method lerp]. [codeblock] @@ -493,12 +411,9 @@ - - - - - - + + + Returns [code]true[/code] if [code]a[/code] and [code]b[/code] are approximately equal to each other. Here, approximately equal means that [code]a[/code] and [code]b[/code] are within a small internal epsilon of each other, which scales with the magnitude of the numbers. @@ -506,47 +421,37 @@ - - - - + + Returns whether [code]s[/code] is an infinity value (either positive infinity or negative infinity). - - - - + + Returns whether [code]instance[/code] is a valid object (e.g. has not been deleted from memory). - - - - + + Returns whether [code]s[/code] is a NaN ("Not a Number" or invalid) value. - - - - + + Returns [code]true[/code] if [code]s[/code] is zero or almost zero. This method is faster than using [method is_equal_approx] with one value as zero. - - - - + + Returns length of Variant [code]var[/code]. Length is the character count of String, element count of Array, size of Dictionary, etc. [b]Note:[/b] Generates a fatal error if Variant can not provide a length. @@ -557,14 +462,10 @@ - - - - - - - - + + + + Linearly interpolates between two values by a normalized value. This is the opposite of [method inverse_lerp]. If the [code]from[/code] and [code]to[/code] arguments are of type [int] or [float], the return value is a [float]. @@ -576,14 +477,10 @@ - - - - - - - - + + + + Linearly interpolates between two angles (in radians) by a normalized value. Similar to [method lerp], but interpolates correctly when the angles wrap around [constant @GDScript.TAU]. @@ -599,10 +496,8 @@ - - - - + + Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn't linear). Example: [codeblock] @@ -614,10 +509,8 @@ - - - - + + Loads a resource from the filesystem located at [code]path[/code]. The resource is loaded on the method call (unless it's referenced already elsewhere, e.g. in another script or in the scene), which might cause slight delay, especially when loading scenes. To avoid unnecessary delays when loading something multiple times, either store the resource in a variable or use [method preload]. [b]Note:[/b] Resource paths can be obtained by right-clicking on a resource in the FileSystem dock and choosing "Copy Path" or by dragging the file from the FileSystem dock into the script. @@ -630,10 +523,8 @@ - - - - + + Natural logarithm. The amount of time needed to reach a certain level of continuous growth. [b]Note:[/b] This is not the same as the "log" function on most calculators, which uses a base 10 logarithm. @@ -644,12 +535,9 @@ - - - - - - + + + Returns the maximum of two values. [codeblock] @@ -659,12 +547,9 @@ - - - - - - + + + Returns the minimum of two values. [codeblock] @@ -674,14 +559,10 @@ - - - - - - - - + + + + Moves [code]from[/code] toward [code]to[/code] by the [code]delta[/code] value. Use a negative [code]delta[/code] value to move away. @@ -693,10 +574,8 @@ - - - - + + Returns the nearest equal or larger power of 2 for integer [code]value[/code]. In other words, returns the smallest value [code]a[/code] where [code]a = pow(2, n)[/code] such that [code]value <= a[/code] for some non-negative integer [code]n[/code]. @@ -712,10 +591,8 @@ - - - - + + Returns an integer representing the Unicode code point of the given Unicode character [code]char[/code]. [codeblock] @@ -727,10 +604,8 @@ - - - - + + Parse JSON text to a Variant. (Use [method typeof] to check if the Variant's type is what you expect.) [b]Note:[/b] The JSON specification does not define integer or float types, but only a [i]number[/i] type. Therefore, parsing a JSON text will convert all numerical values to [float] types. @@ -746,23 +621,17 @@ - - - - - - + + + Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (X and Y axis). - - - - - - + + + Returns the integer modulus of [code]a/b[/code] that wraps equally in positive and negative. [codeblock] @@ -782,12 +651,9 @@ - - - - - - + + + Returns the result of [code]base[/code] raised to the power of [code]exp[/code]. [codeblock] @@ -796,10 +662,8 @@ - - - - + + Returns a [Resource] from the filesystem located at [code]path[/code]. The resource is loaded during script parsing, i.e. is loaded with the script and [method preload] effectively acts as a reference to that resource. Note that the method requires a constant path. If you want to load a resource from a dynamic/variable path, use [method load]. [b]Note:[/b] Resource paths can be obtained by right clicking on a resource in the Assets Panel and choosing "Copy Path" or by dragging the file from the FileSystem dock into the script. @@ -810,8 +674,7 @@ - - + Converts one or more arguments of any type to string in the best way possible and prints them to the console. [codeblock] @@ -822,15 +685,13 @@ - - + Like [method print], but prints only when used in debug mode. - - + Prints a stack track at code location, only works when running with debugger turned on. Output in the console would look something like this: @@ -840,8 +701,7 @@ - - + Prints one or more arguments to strings in the best way possible to standard error line. [codeblock] @@ -850,8 +710,7 @@ - - + Prints one or more arguments to strings in the best way possible to console. No newline is added at the end. [codeblock] @@ -863,8 +722,7 @@ - - + Prints one or more arguments to the console with a space between each argument. [codeblock] @@ -873,8 +731,7 @@ - - + Prints one or more arguments to the console with a tab between each argument. [codeblock] @@ -883,10 +740,8 @@ - - - - + + Pushes an error message to Godot's built-in debugger and to the OS terminal. [codeblock] @@ -896,10 +751,8 @@ - - - - + + Pushes a warning message to Godot's built-in debugger and to the OS terminal. [codeblock] @@ -908,10 +761,8 @@ - - - - + + Converts an angle expressed in radians to degrees. [codeblock] @@ -920,12 +771,9 @@ - - - - - - + + + Random range, any floating point value between [code]from[/code] and [code]to[/code]. [codeblock] @@ -934,17 +782,14 @@ - - - - + + Random from seed: pass a [code]seed[/code], and an array with both number and new seed is returned. "Seed" here refers to the internal state of the pseudo random number generator. The internal state of the current implementation is 64 bits. - - + Returns a random floating point value on the interval [code][0, 1][/code]. [codeblock] @@ -953,8 +798,7 @@ - - + Returns a random unsigned 32-bit integer. Use remainder to obtain a random value in the interval [code][0, N - 1][/code] (where N is smaller than 2^32). [codeblock] @@ -966,8 +810,7 @@ - - + Randomizes the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. [codeblock] @@ -977,8 +820,7 @@ - - + Returns an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment). [codeblock] @@ -995,18 +837,12 @@ - - - - - - - - - - - - + + + + + + Maps a [code]value[/code] from range [code][istart, istop][/code] to [code][ostart, ostop][/code]. [codeblock] @@ -1015,10 +851,8 @@ - - - - + + Rounds [code]s[/code] to the nearest whole number, with halfway cases rounded away from zero. [codeblock] @@ -1030,10 +864,8 @@ - - - - + + Sets seed for the random number generator. [codeblock] @@ -1043,10 +875,8 @@ - - - - + + Returns the sign of [code]s[/code]: -1 or 1. Returns 0 if [code]s[/code] is 0. [codeblock] @@ -1057,10 +887,8 @@ - - - - + + Returns the sine of angle [code]s[/code] in radians. [codeblock] @@ -1069,10 +897,8 @@ - - - - + + Returns the hyperbolic sine of [code]s[/code]. [codeblock] @@ -1082,14 +908,10 @@ - - - - - - - - + + + + Returns the result of smoothly interpolating the value of [code]s[/code] between [code]0[/code] and [code]1[/code], based on the where [code]s[/code] lies with respect to the edges [code]from[/code] and [code]to[/code]. The return value is [code]0[/code] if [code]s <= from[/code], and [code]1[/code] if [code]s >= to[/code]. If [code]s[/code] lies between [code]from[/code] and [code]to[/code], the returned value follows an S-shaped curve that maps [code]s[/code] between [code]0[/code] and [code]1[/code]. @@ -1103,10 +925,8 @@ - - - - + + Returns the square root of [code]s[/code], where [code]s[/code] is a non-negative number. [codeblock] @@ -1116,10 +936,8 @@ - - - - + + Returns the position of the first non-zero digit, after the decimal point. Note that the maximum return value is 10, which is a design decision in the implementation. [codeblock] @@ -1130,12 +948,9 @@ - - - - - - + + + Snaps float value [code]s[/code] to a given [code]step[/code]. This can also be used to round a floating point number to an arbitrary number of decimals. [codeblock] @@ -1146,8 +961,7 @@ - - + Converts one or more arguments of any type to string in the best way possible. [codeblock] @@ -1159,10 +973,8 @@ - - - - + + Converts a formatted string that was returned by [method var2str] to the original value. [codeblock] @@ -1173,10 +985,8 @@ - - - - + + Returns the tangent of angle [code]s[/code] in radians. [codeblock] @@ -1185,10 +995,8 @@ - - - - + + Returns the hyperbolic tangent of [code]s[/code]. [codeblock] @@ -1198,10 +1006,8 @@ - - - - + + Converts a [Variant] [code]var[/code] to JSON text and return the result. Useful for serializing data to store or send over the network. [codeblock] @@ -1216,10 +1022,8 @@ - - - - + + Returns whether the given class exists in [ClassDB]. [codeblock] @@ -1229,10 +1033,8 @@ - - - - + + Returns the internal type of the given Variant object, using the [enum Variant.Type] values. [codeblock] @@ -1245,10 +1047,8 @@ - - - - + + Checks that [code]json[/code] is valid JSON data. Returns an empty string if valid, or an error message otherwise. [codeblock] @@ -1262,21 +1062,16 @@ - - - - - - + + + Encodes a variable value to a byte array. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). - - - - + + Converts a Variant [code]var[/code] to a formatted string that can later be parsed using [method str2var]. [codeblock] @@ -1293,24 +1088,18 @@ - - - - + + Returns a weak reference to an object. A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. - - - - - - - - + + + + Wraps float [code]value[/code] between [code]min[/code] and [code]max[/code]. Usable for creating loop-alike behavior or infinite surfaces. @@ -1331,14 +1120,10 @@ - - - - - - - - + + + + Wraps integer [code]value[/code] between [code]min[/code] and [code]max[/code]. Usable for creating loop-alike behavior or infinite surfaces. @@ -1355,12 +1140,9 @@ - - - - - - + + + Stops the function execution and returns the current suspended state to the calling function. From the caller, call [method GDScriptFunctionState.resume] on the state to resume execution. This invalidates the state. Within the resumed function, [code]yield()[/code] returns whatever was passed to the [code]resume()[/code] function call. diff --git a/modules/gdscript/doc_classes/GDScript.xml b/modules/gdscript/doc_classes/GDScript.xml index 3c538ea4e88..b6fe2c177e2 100644 --- a/modules/gdscript/doc_classes/GDScript.xml +++ b/modules/gdscript/doc_classes/GDScript.xml @@ -12,15 +12,13 @@ - - + Returns byte code for the script source code. - - + Returns a new instance of the script. For example: diff --git a/modules/gdscript/doc_classes/GDScriptFunctionState.xml b/modules/gdscript/doc_classes/GDScriptFunctionState.xml index f1817fd413f..734c870a549 100644 --- a/modules/gdscript/doc_classes/GDScriptFunctionState.xml +++ b/modules/gdscript/doc_classes/GDScriptFunctionState.xml @@ -10,20 +10,16 @@ - - - - + + Check whether the function call may be resumed. This is not the case if the function state was already resumed. If [code]extended_check[/code] is enabled, it also checks if the associated script and object still exist. The extended check is done in debug mode as part of [method GDScriptFunctionState.resume], but you can use this if you know you may be trying to resume without knowing for sure the object and/or script have survived up to that point. - - - - + + Resume execution of the yielded function call. If handed an argument, return the argument from the [method @GDScript.yield] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments. @@ -33,8 +29,7 @@ - - + diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index 10dbb3e9d4d..302019ac92c 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -17,135 +17,101 @@ - - + Clear all cells. - - + - - - - + + - - + Returns an array of [ArrayMesh]es and [Transform] references of all bake meshes that exist within the current GridMap. - - - - - - - - + + + + The [MeshLibrary] item index located at the grid-based X, Y and Z coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned. - - - - - - - - + + + + The orientation of the cell at the grid-based X, Y and Z coordinates. -1 is returned if the cell is empty. - - - - + + Returns an individual bit on the [member collision_layer]. - - - - + + Returns an individual bit on the [member collision_mask]. - - + Returns an array of [Transform] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in world space. - - + Returns an array of [Vector3] with the non-empty cell coordinates in the grid map. - - - - - - + + + - - - - - - - - + + + + Returns the position of a grid cell in the GridMap's local coordinate space. - - - - + + - - - - - - - - - - - - + + + + + + Sets the mesh index for the cell referenced by its grid-based X, Y and Z coordinates. A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell. @@ -153,46 +119,33 @@ - - - - - - - - - - + + + + + - - - - - - + + + Sets an individual bit on the [member collision_layer]. - - - - - - + + + Sets an individual bit on the [member collision_mask]. - - - - + + Returns the coordinates of the grid cell containing the given point. [code]pos[/code] should be in the GridMap's local coordinate space. @@ -236,8 +189,7 @@ - - + Emitted when [member cell_size] changes. diff --git a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml index c1bc1130e12..15c088edc33 100644 --- a/modules/opensimplex/doc_classes/OpenSimplexNoise.xml +++ b/modules/opensimplex/doc_classes/OpenSimplexNoise.xml @@ -25,88 +25,65 @@ - - - - - - + + + Generate a noise image in [constant Image.FORMAT_L8] format with the requested [code]width[/code] and [code]height[/code], based on the current noise parameters. - - - - + + Returns the 1D noise value [code][-1,1][/code] at the given x-coordinate. [b]Note:[/b] This method actually returns the 2D noise value [code][-1,1][/code] with fixed y-coordinate value 0.0. - - - - - - + + + Returns the 2D noise value [code][-1,1][/code] at the given position. - - - - + + Returns the 2D noise value [code][-1,1][/code] at the given position. - - - - - - - - + + + + Returns the 3D noise value [code][-1,1][/code] at the given position. - - - - + + Returns the 3D noise value [code][-1,1][/code] at the given position. - - - - - - - - - - + + + + + Returns the 4D noise value [code][-1,1][/code] at the given position. - - - - + + Generate a tileable noise image in [constant Image.FORMAT_L8] format, based on the current noise parameters. Generated seamless images are always square ([code]size[/code] × [code]size[/code]). [b]Note:[/b] Seamless noise has a lower contrast compared to non-seamless noise. This is due to the way noise uses higher dimensions for generating seamless noise. diff --git a/modules/regex/doc_classes/RegEx.xml b/modules/regex/doc_classes/RegEx.xml index 45304446a2b..2064d3c0335 100644 --- a/modules/regex/doc_classes/RegEx.xml +++ b/modules/regex/doc_classes/RegEx.xml @@ -50,88 +50,67 @@ - - + This method resets the state of the object, as if it was freshly created. Namely, it unassigns the regular expression of this object. - - - - + + Compiles and assign the search pattern to use. Returns [constant OK] if the compilation is successful. If an error is encountered, details are printed to standard output and an error is returned. - - + Returns the number of capturing groups in compiled pattern. - - + Returns an array of names of named capturing groups in the compiled pattern. They are ordered by appearance. - - + Returns the original search pattern that was compiled. - - + Returns whether this object has a valid search pattern assigned. - - - - - - - - + + + + Searches the text for the compiled pattern. Returns a [RegExMatch] container of the first matching result if found, otherwise [code]null[/code]. The region to search within can be specified without modifying where the start and end anchor would be. - - - - - - - - + + + + Searches the text for the compiled pattern. Returns an array of [RegExMatch] containers for each non-overlapping result. If no results were found, an empty array is returned instead. The region to search within can be specified without modifying where the start and end anchor would be. - - - - - - - - - - - - + + + + + + Searches the text for the compiled pattern and replaces it with the specified string. Escapes and backreferences such as [code]$1[/code] and [code]$name[/code] are expanded and resolved. By default, only the first instance is replaced, but it can be changed for all instances (global replacement). The region to search within can be specified without modifying where the start and end anchor would be. diff --git a/modules/regex/doc_classes/RegExMatch.xml b/modules/regex/doc_classes/RegExMatch.xml index 119d607a707..e0a503ffe3d 100644 --- a/modules/regex/doc_classes/RegExMatch.xml +++ b/modules/regex/doc_classes/RegExMatch.xml @@ -10,37 +10,30 @@ - - - - + + Returns the end position of the match within the source string. The end position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. Returns -1 if the group did not match or doesn't exist. - - + Returns the number of capturing groups. - - - - + + Returns the starting position of the match within the source string. The starting position of capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. Returns -1 if the group did not match or doesn't exist. - - - - + + Returns the substring of the match from the source string. Capturing groups can be retrieved by providing its group number as an integer or its string name (if it's a named group). The default value of 0 refers to the whole pattern. Returns an empty string if the group did not match or doesn't exist. diff --git a/modules/theora/doc_classes/VideoStreamTheora.xml b/modules/theora/doc_classes/VideoStreamTheora.xml index 975c6eaf50b..27be21d935e 100644 --- a/modules/theora/doc_classes/VideoStreamTheora.xml +++ b/modules/theora/doc_classes/VideoStreamTheora.xml @@ -11,17 +11,14 @@ - - + Returns the Ogg Theora video file handled by this [VideoStreamTheora]. - - - - + + Sets the Ogg Theora video file that this [VideoStreamTheora] resource handles. The [code]file[/code] name should have the [code].ogv[/code] extension. diff --git a/modules/upnp/doc_classes/UPNP.xml b/modules/upnp/doc_classes/UPNP.xml index 9a63f33fafc..0171d25a0ed 100644 --- a/modules/upnp/doc_classes/UPNP.xml +++ b/modules/upnp/doc_classes/UPNP.xml @@ -21,27 +21,19 @@ - - - - + + Adds the given [UPNPDevice] to the list of discovered devices. - - - - - - - - - - - - + + + + + + Adds a mapping to forward the external [code]port[/code] (between 1 and 65535) on the default gateway (see [method get_gateway]) to the [code]internal_port[/code] on the local machine for the given protocol [code]proto[/code] (either [code]TCP[/code] or [code]UDP[/code], with UDP being the default). If a port mapping for the given port and protocol combination already exists on that gateway device, this method tries to overwrite it. If that is not desired, you can retrieve the gateway manually with [method get_gateway] and call [method add_port_mapping] on it, if any. If [code]internal_port[/code] is [code]0[/code] (the default), the same port number is used for both the external and the internal port (the [code]port[/code] value). @@ -50,32 +42,24 @@ - - + Clears the list of discovered devices. - - - - - - + + + Deletes the port mapping for the given port and protocol combination on the default gateway (see [method get_gateway]) if one exists. [code]port[/code] must be a valid port between 1 and 65535, [code]proto[/code] can be either [code]TCP[/code] or [code]UDP[/code]. See [enum UPNPResult] for possible return values. - - - - - - - - + + + + Discovers local [UPNPDevice]s. Clears the list of previously discovered devices. Filters for IGD (InternetGatewayDevice) type devices by default, as those manage port forwarding. [code]timeout[/code] is the time to wait for responses in milliseconds. [code]ttl[/code] is the time-to-live; only touch this if you know what you're doing. @@ -83,51 +67,41 @@ - - - - + + Returns the [UPNPDevice] at the given [code]index[/code]. - - + Returns the number of discovered [UPNPDevice]s. - - + Returns the default gateway. That is the first discovered [UPNPDevice] that is also a valid IGD (InternetGatewayDevice). - - + Returns the external [IP] address of the default gateway (see [method get_gateway]) as string. Returns an empty string on error. - - - - + + Removes the device at [code]index[/code] from the list of discovered devices. - - - - - - + + + Sets the device at [code]index[/code] from the list of discovered devices to [code]device[/code]. diff --git a/modules/upnp/doc_classes/UPNPDevice.xml b/modules/upnp/doc_classes/UPNPDevice.xml index bbf4a979549..ac0d67efcb0 100644 --- a/modules/upnp/doc_classes/UPNPDevice.xml +++ b/modules/upnp/doc_classes/UPNPDevice.xml @@ -10,43 +10,32 @@ - - - - - - - - - - - - + + + + + + Adds a port mapping to forward the given external port on this [UPNPDevice] for the given protocol to the local machine. See [method UPNP.add_port_mapping]. - - - - - - + + + Deletes the port mapping identified by the given port and protocol combination on this device. See [method UPNP.delete_port_mapping]. - - + Returns [code]true[/code] if this is a valid IGD (InternetGatewayDevice) which potentially supports port forwarding. - - + Returns the external IP address of this [UPNPDevice] or an empty string. diff --git a/modules/visual_script/doc_classes/VisualScript.xml b/modules/visual_script/doc_classes/VisualScript.xml index f0e1f77e7cd..eaa12a3d64e 100644 --- a/modules/visual_script/doc_classes/VisualScript.xml +++ b/modules/visual_script/doc_classes/VisualScript.xml @@ -13,482 +13,347 @@ - - - - + + Add a custom signal with the specified name to the VisualScript. - - - - + + Add a function with the specified name to the VisualScript. - - - - - - - - - - + + + + + Add a node to a function of the VisualScript. - - - - - - - - + + + + Add a variable to the VisualScript, optionally giving it a default value or marking it as exported. - - - - - - - - - - + + + + + Add an argument to a custom signal added with [method add_custom_signal]. - - - - + + Get the count of a custom signal's arguments. - - - - - - + + + Get the name of a custom signal's argument. - - - - - - + + + Get the type of a custom signal's argument. - - - - - - + + + Remove a specific custom signal's argument. - - - - - - - - + + + + Rename a custom signal's argument. - - - - - - - - + + + + Change the type of a custom signal's argument. - - - - - - - - + + + + Swap two of the arguments of a custom signal. - - - - - - - - - - - - + + + + + + Connect two data ports. The value of [code]from_node[/code]'s [code]from_port[/code] would be fed into [code]to_node[/code]'s [code]to_port[/code]. - - - - - - - - - - - - + + + + + + Disconnect two data ports previously connected with [method data_connect]. - - - - + + Returns the id of a function's entry point node. - - - - + + Returns the position of the center of the screen for a given function. - - - - - - + + + Returns a node given its id and its function. - - - - - - + + + Returns a node's position in pixels. - - - - + + Returns the default (initial) value of a variable. - - - - + + Returns whether a variable is exported. - - - - + + Returns the information for a given variable as a dictionary. The information includes its name, type, hint and usage. - - - - + + Returns whether a signal exists with the specified name. - - - - - - - - - - - - + + + + + + Returns whether the specified data ports are connected. - - - - + + Returns whether a function exists with the specified name. - - - - - - + + + Returns whether a node exists with the given id. - - - - - - - - - - + + + + + Returns whether the specified sequence ports are connected. - - - - + + Returns whether a variable exists with the specified name. - - - - + + Remove a custom signal with the given name. - - - - + + Remove a specific function and its nodes from the script. - - - - - - + + + Remove a specific node. - - - - + + Remove a variable with the given name. - - - - - - + + + Change the name of a custom signal. - - - - - - + + + Change the name of a function. - - - - - - + + + Change the name of a variable. - - - - - - - - - - + + + + + Connect two sequence ports. The execution will flow from of [code]from_node[/code]'s [code]from_output[/code] into [code]to_node[/code]. Unlike [method data_connect], there isn't a [code]to_port[/code], since the target node can have only one sequence port. - - - - - - - - - - + + + + + Disconnect two sequence ports previously connected with [method sequence_connect]. - - - - - - + + + Position the center of the screen for a function. - - - - + + Set the base type of the script. - - - - - - - - + + + + Position a node on the screen. - - - - - - + + + Change the default (initial) value of a variable. - - - - - - + + + Change whether a variable is exported. - - - - - - + + + Set a variable's info, using the same format as [method get_variable_info]. @@ -496,10 +361,8 @@ - - - - + + Emitted when the ports of a node are changed. diff --git a/modules/visual_script/doc_classes/VisualScriptConstructor.xml b/modules/visual_script/doc_classes/VisualScriptConstructor.xml index 8c5756f7314..f39bd16a2a0 100644 --- a/modules/visual_script/doc_classes/VisualScriptConstructor.xml +++ b/modules/visual_script/doc_classes/VisualScriptConstructor.xml @@ -10,30 +10,24 @@ - - + - - + - - - - + + - - - - + + diff --git a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml index e35e7765422..4d76ad7f532 100644 --- a/modules/visual_script/doc_classes/VisualScriptCustomNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptCustomNode.xml @@ -10,117 +10,94 @@ - - + Return the node's title. - - + Return the node's category. - - + Return the count of input value ports. - - - - + + Return the specified input port's name. - - - - + + Return the specified input port's type. See the [enum Variant.Type] values. - - + Return the amount of output [b]sequence[/b] ports. - - - - + + Return the specified [b]sequence[/b] output's name. - - + Return the amount of output value ports. - - - - + + Return the specified output's name. - - - - + + Return the specified output's type. See the [enum Variant.Type] values. - - + Return the custom node's text, which is shown right next to the input [b]sequence[/b] port (if there is none, on the place that is usually taken by it). - - + Return the size of the custom node's working memory. See [method _step] for more details. - - + Return whether the custom node has an input [b]sequence[/b] port. - - - - - - - - - - + + + + + Execute the custom node's logic, returning the index of the output sequence port to use or a [String] when there is an error. The [code]inputs[/code] array contains the values of the input ports. diff --git a/modules/visual_script/doc_classes/VisualScriptEditor.xml b/modules/visual_script/doc_classes/VisualScriptEditor.xml index 27553f8876f..84f489e1958 100644 --- a/modules/visual_script/doc_classes/VisualScriptEditor.xml +++ b/modules/visual_script/doc_classes/VisualScriptEditor.xml @@ -8,25 +8,18 @@ - - - - - - - - + + + + Add a custom Visual Script node to the editor. It'll be placed under "Custom Nodes" with the [code]category[/code] as the parameter. - - - - - - + + + Remove a custom Visual Script node from the editor. Custom nodes already placed on scripts won't be removed. diff --git a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml index 9e4bb7f1ebc..da6863fa564 100644 --- a/modules/visual_script/doc_classes/VisualScriptFunctionState.xml +++ b/modules/visual_script/doc_classes/VisualScriptFunctionState.xml @@ -8,28 +8,21 @@ - - - - - - - - + + + + - - + - - - - + + diff --git a/modules/visual_script/doc_classes/VisualScriptLists.xml b/modules/visual_script/doc_classes/VisualScriptLists.xml index aa8fdac548f..a702bb3071a 100644 --- a/modules/visual_script/doc_classes/VisualScriptLists.xml +++ b/modules/visual_script/doc_classes/VisualScriptLists.xml @@ -10,82 +10,58 @@ - - - - - - - - + + + + - - - - - - - - + + + + - - - - + + - - - - + + - - - - - - + + + - - - - - - + + + - - - - - - + + + - - - - - - + + + diff --git a/modules/visual_script/doc_classes/VisualScriptNode.xml b/modules/visual_script/doc_classes/VisualScriptNode.xml index 943382d9faa..928d4135254 100644 --- a/modules/visual_script/doc_classes/VisualScriptNode.xml +++ b/modules/visual_script/doc_classes/VisualScriptNode.xml @@ -10,35 +10,28 @@ - - - - + + Returns the default value of a given port. The default value is used when nothing is connected to the port. - - + Returns the [VisualScript] instance the node is bound to. - - + Notify that the node's ports have changed. Usually used in conjunction with [VisualScriptCustomNode] . - - - - - - + + + Change the default value of a given port. diff --git a/modules/visual_script/doc_classes/VisualScriptSubCall.xml b/modules/visual_script/doc_classes/VisualScriptSubCall.xml index 60ec5ed7838..b29813ba42e 100644 --- a/modules/visual_script/doc_classes/VisualScriptSubCall.xml +++ b/modules/visual_script/doc_classes/VisualScriptSubCall.xml @@ -8,10 +8,8 @@ - - - - + + diff --git a/modules/webm/doc_classes/VideoStreamWebm.xml b/modules/webm/doc_classes/VideoStreamWebm.xml index 1e1f7501953..cb5c8390584 100644 --- a/modules/webm/doc_classes/VideoStreamWebm.xml +++ b/modules/webm/doc_classes/VideoStreamWebm.xml @@ -12,17 +12,14 @@ - - + Returns the WebM video file handled by this [VideoStreamWebm]. - - - - + + Sets the WebM video file that this [VideoStreamWebm] resource handles. The [code]file[/code] name should have the [code].webm[/code] extension. diff --git a/modules/webrtc/doc_classes/WebRTCDataChannel.xml b/modules/webrtc/doc_classes/WebRTCDataChannel.xml index e905240065a..b9e861b0da7 100644 --- a/modules/webrtc/doc_classes/WebRTCDataChannel.xml +++ b/modules/webrtc/doc_classes/WebRTCDataChannel.xml @@ -8,81 +8,70 @@ - - + Closes this data channel, notifying the other peer. - - + Returns the id assigned to this channel during creation (or auto-assigned during negotiation). If the channel is not negotiated out-of-band the id will only be available after the connection is established (will return [code]65535[/code] until then). - - + Returns the label assigned to this channel during creation. - - + Returns the [code]maxPacketLifeTime[/code] value assigned to this channel during creation. Will be [code]65535[/code] if not specified. - - + Returns the [code]maxRetransmits[/code] value assigned to this channel during creation. Will be [code]65535[/code] if not specified. - - + Returns the sub-protocol assigned to this channel during creation. An empty string if not specified. - - + Returns the current state of this channel, see [enum ChannelState]. - - + Returns [code]true[/code] if this channel was created with out-of-band configuration. - - + Returns [code]true[/code] if this channel was created with ordering enabled (default). - - + Reserved, but not used for now. - - + Returns [code]true[/code] if the last received packet was transferred as text. See [member write_mode]. diff --git a/modules/webrtc/doc_classes/WebRTCMultiplayer.xml b/modules/webrtc/doc_classes/WebRTCMultiplayer.xml index ee3a3154ce4..ddc5430ecda 100644 --- a/modules/webrtc/doc_classes/WebRTCMultiplayer.xml +++ b/modules/webrtc/doc_classes/WebRTCMultiplayer.xml @@ -12,58 +12,45 @@ - - - - - - - - + + + + Add a new peer to the mesh with the given [code]peer_id[/code]. The [WebRTCPeerConnection] must be in state [constant WebRTCPeerConnection.STATE_NEW]. Three channels will be created for reliable, unreliable, and ordered transport. The value of [code]unreliable_lifetime[/code] will be passed to the [code]maxPacketLifetime[/code] option when creating unreliable and ordered channels (see [method WebRTCPeerConnection.create_data_channel]). - - + Close all the add peer connections and channels, freeing all resources. - - - - + + Return a dictionary representation of the peer with given [code]peer_id[/code] with three keys. [code]connection[/code] containing the [WebRTCPeerConnection] to this peer, [code]channels[/code] an array of three [WebRTCDataChannel], and [code]connected[/code] a boolean representing if the peer connection is currently connected (all three channels are open). - - + Returns a dictionary which keys are the peer ids and values the peer representation as in [method get_peer]. - - - - + + Returns [code]true[/code] if the given [code]peer_id[/code] is in the peers map (it might not be connected though). - - - - - - + + + Initialize the multiplayer peer with the given [code]peer_id[/code] (must be between 1 and 2147483647). If [code]server_compatibilty[/code] is [code]false[/code] (default), the multiplayer peer will be immediately in state [constant NetworkedMultiplayerPeer.CONNECTION_CONNECTED] and [signal NetworkedMultiplayerPeer.connection_succeeded] will not be emitted. @@ -71,10 +58,8 @@ - - - - + + Remove the peer with given [code]peer_id[/code] from the mesh. If the peer was connected, and [signal NetworkedMultiplayerPeer.peer_connected] was emitted for it, then [signal NetworkedMultiplayerPeer.peer_disconnected] will be emitted. diff --git a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml index 4a130aaf4af..1afae56c58f 100644 --- a/modules/webrtc/doc_classes/WebRTCPeerConnection.xml +++ b/modules/webrtc/doc_classes/WebRTCPeerConnection.xml @@ -15,33 +15,25 @@ - - - - - - - - + + + + Add an ice candidate generated by a remote peer (and received over the signaling server). See [signal ice_candidate_created]. - - + Close the peer connection and all data channels associated with it. Note, you cannot reuse this object for a new connection unless you call [method initialize]. - - - - + + - +}" /> Returns a new [WebRTCDataChannel] (or [code]null[/code] on failure) with given [code]label[/code] and optionally configured via the [code]options[/code] dictionary. This method can only be called when the connection is in state [constant STATE_NEW]. There are two ways to create a working data channel: either call [method create_data_channel] on only one of the peer and listen to [signal data_channel_received] on the other, or call [method create_data_channel] on both peers, with the same values, and the [code]negotiated[/code] option set to [code]true[/code]. @@ -63,26 +55,22 @@ - - + Creates a new SDP offer to start a WebRTC connection with a remote peer. At least one [WebRTCDataChannel] must have been created before calling this method. If this functions returns [constant OK], [signal session_description_created] will be called when the session is ready to be sent. - - + Returns the connection state. See [enum ConnectionState]. - - + - +}" /> Re-initialize this peer connection, closing any previously active connection, and going back to state [constant STATE_NEW]. A dictionary of [code]options[/code] can be passed to configure the peer connection. Valid [code]options[/code] are: @@ -103,31 +91,24 @@ - - + Call this method frequently (e.g. in [method Node._process] or [method Node._physics_process]) to properly receive signals. - - - - - - + + + Sets the SDP description of the local peer. This should be called in response to [signal session_description_created]. After calling this function the peer will start emitting [signal ice_candidate_created] (unless an [enum Error] different from [constant OK] is returned). - - - - - - + + + Sets the SDP description of the remote peer. This should be called with the values generated by a remote peer and received over the signaling server. If [code]type[/code] is [code]offer[/code] the peer will emit [signal session_description_created] with the appropriate answer. @@ -137,29 +118,23 @@ - - + Emitted when a new in-band channel is received, i.e. when the channel was created with [code]negotiated: false[/code] (default). The object will be an instance of [WebRTCDataChannel]. You must keep a reference of it or it will be closed automatically. See [method create_data_channel]. - - - - - - + + + Emitted when a new ICE candidate has been created. The three parameters are meant to be passed to the remote peer over the signaling server. - - - - + + Emitted after a successful call to [method create_offer] or [method set_remote_description] (when it generates an answer). The parameters are meant to be passed to [method set_local_description] on this object, and sent to the remote peer over the signaling server. diff --git a/modules/websocket/doc_classes/WebSocketClient.xml b/modules/websocket/doc_classes/WebSocketClient.xml index 67f40872fd4..203ed35ec8f 100644 --- a/modules/websocket/doc_classes/WebSocketClient.xml +++ b/modules/websocket/doc_classes/WebSocketClient.xml @@ -13,16 +13,11 @@ - - - - - - - - - - + + + + + Connects to the given URL requesting one of the given [code]protocols[/code] as sub-protocol. If the list empty (default), no sub-protocol will be requested. If [code]true[/code] is passed as [code]gd_mp_api[/code], the client will behave like a network peer for the [MultiplayerAPI], connections to non-Godot servers will not work, and [signal data_received] will not be emitted. @@ -33,26 +28,21 @@ - - - - - - + + + Disconnects this client from the connected host. See [method WebSocketPeer.close] for more information. - - + Return the IP address of the currently connected host. - - + Return the IP port of the currently connected host. @@ -70,8 +60,7 @@ - - + Emitted when the connection to the server is closed. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly. @@ -82,8 +71,7 @@ - - + Emitted when a connection with the server is established, [code]protocol[/code] will contain the sub-protocol agreed with the server. @@ -95,10 +83,8 @@ - - - - + + Emitted when the server requests a clean close. You should keep polling until you get a [signal connection_closed] signal to achieve the clean close. See [method WebSocketPeer.close] for more details. diff --git a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml index 07c14903009..183048959dd 100644 --- a/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml +++ b/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml @@ -10,25 +10,18 @@ - - - - + + Returns the [WebSocketPeer] associated to the given [code]peer_id[/code]. - - - - - - - - - - + + + + + Configures the buffer sizes for this WebSocket peer. Default values can be specified in the Project Settings under [code]network/limits[/code]. For server, values are meant per connected peer. The first two parameters define the size and queued packets limits of the input buffer, the last two of the output buffer. @@ -43,8 +36,7 @@ - - + Emitted when a packet is received from a peer. [b]Note:[/b] This signal is only emitted when the client or server is configured to use Godot multiplayer API. diff --git a/modules/websocket/doc_classes/WebSocketPeer.xml b/modules/websocket/doc_classes/WebSocketPeer.xml index 0a0ab79dc89..847a4fb3e89 100644 --- a/modules/websocket/doc_classes/WebSocketPeer.xml +++ b/modules/websocket/doc_classes/WebSocketPeer.xml @@ -11,12 +11,9 @@ - - - - - - + + + Closes this WebSocket connection. [code]code[/code] is the status code for the closure (see RFC 6455 section 7.4 for a list of valid status codes). [code]reason[/code] is the human readable reason for closing the connection (can be any UTF-8 string that's smaller than 123 bytes). [b]Note:[/b] To achieve a clean close, you will need to keep polling until either [signal WebSocketClient.connection_closed] or [signal WebSocketServer.client_disconnected] is received. @@ -24,64 +21,54 @@ - - + Returns the IP address of the connected peer. [b]Note:[/b] Not available in the HTML5 export. - - + Returns the remote port of the connected peer. [b]Note:[/b] Not available in the HTML5 export. - - + Returns the current amount of data in the outbound websocket buffer. [b]Note:[/b] HTML5 exports use WebSocket.bufferedAmount, while other platforms use an internal buffer. - - + Gets the current selected write mode. See [enum WriteMode]. - - + Returns [code]true[/code] if this peer is currently connected. - - - - + + Disable Nagle's algorithm on the underling TCP socket (default). See [method StreamPeerTCP.set_no_delay] for more information. [b]Note:[/b] Not available in the HTML5 export. - - - - + + Sets the socket to use the given [enum WriteMode]. - - + Returns [code]true[/code] if the last received packet was sent as a text payload. See [enum WriteMode]. diff --git a/modules/websocket/doc_classes/WebSocketServer.xml b/modules/websocket/doc_classes/WebSocketServer.xml index 1da1164b2ac..b4e9fc0f81c 100644 --- a/modules/websocket/doc_classes/WebSocketServer.xml +++ b/modules/websocket/doc_classes/WebSocketServer.xml @@ -12,61 +12,46 @@ - - - - - - - - + + + + Disconnects the peer identified by [code]id[/code] from the server. See [method WebSocketPeer.close] for more information. - - - - + + Returns the IP address of the given peer. - - - - + + Returns the remote port of the given peer. - - - - + + Returns [code]true[/code] if a peer with the given ID is connected. - - + Returns [code]true[/code] if the server is actively listening on a port. - - - - - - - - + + + + Starts listening on the given port. You can specify the desired subprotocols via the "protocols" array. If the list empty (default), no sub-protocol will be requested. @@ -75,8 +60,7 @@ - - + Stops the server and clear its state. @@ -98,37 +82,29 @@ - - - - - - + + + Emitted when a client requests a clean close. You should keep polling until you get a [signal client_disconnected] signal with the same [code]id[/code] to achieve the clean close. See [method WebSocketPeer.close] for more details. - - - - + + Emitted when a new client connects. "protocol" will be the sub-protocol agreed with the client. - - - - + + Emitted when a client disconnects. [code]was_clean_close[/code] will be [code]true[/code] if the connection was shutdown cleanly. - - + Emitted when a new message is received. [b]Note:[/b] This signal is [i]not[/i] emitted when used as high-level multiplayer peer. diff --git a/modules/webxr/doc_classes/WebXRInterface.xml b/modules/webxr/doc_classes/WebXRInterface.xml index 465954c7e33..4c6f5419098 100644 --- a/modules/webxr/doc_classes/WebXRInterface.xml +++ b/modules/webxr/doc_classes/WebXRInterface.xml @@ -95,10 +95,8 @@ - - - - + + Gets an [ARVRPositionalTracker] for the given [code]controller_id[/code]. In the context of WebXR, a "controller" can be an advanced VR controller like the Oculus Touch or Index controllers, or even a tap on the screen, a spoken voice command or a button press on the device itself. When a non-traditional controller is used, interpret the position and orientation of the [ARVRPositionalTracker] as a ray pointing at the object the user wishes to interact with. @@ -112,10 +110,8 @@ - - - - + + Checks if the given [code]session_mode[/code] is supported by the user's browser. Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRSessionMode]WebXR's XRSessionMode[/url], including: [code]"immersive-vr"[/code], [code]"immersive-ar"[/code], and [code]"inline"[/code]. @@ -170,24 +166,21 @@ - - + Emitted after one of the "controllers" has finished its "primary action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has finished its "primary action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has started its "primary action". Use [method get_controller] to get more information about the controller. @@ -200,8 +193,7 @@ - - + Emitted by [method ARVRInterface.initialize] if the session fails to start. [code]message[/code] may optionally contain an error message from WebXR, or an empty string if no message is available. @@ -214,33 +206,28 @@ - - - - + + Emitted by [method is_session_supported] to indicate if the given [code]session_mode[/code] is supported or not. - - + Emitted after one of the "controllers" has finished its "primary squeeze action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has finished its "primary squeeze action". Use [method get_controller] to get more information about the controller. - - + Emitted when one of the "controllers" has started its "primary squeeze action". Use [method get_controller] to get more information about the controller.