diff --git a/doc/base/classes.xml b/doc/base/classes.xml index abe2c4e3d45..deb0b3ad8d2 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -97,7 +97,7 @@ - Arc-tangent that takes a 2D vector as argument, retuns the full -pi to +pi range. + Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range. @@ -344,7 +344,7 @@ - Convert from radias to degrees. + Convert from radian to degrees. @@ -2113,7 +2113,7 @@ - Add a track to the Animation. The track type must be specified as any of the values in te TYPE_* enumeration. + Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. @@ -2176,7 +2176,7 @@ - Nove a track down. + Move a track down. @@ -2346,7 +2346,7 @@ - Return wether interpolation is enabled or disabled for a whole track. By default tracks are interpolated. + Return whether interpolation is enabled or disabled for a whole track. By default tracks are interpolated. @@ -2422,7 +2422,7 @@ - Return wether the animation has the loop flag set. + Return whether the animation has the loop flag set. @@ -2469,7 +2469,7 @@ Container and player of [Animation] resources. - An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in diferent channels. + An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. @@ -2505,7 +2505,7 @@ - Request wether an [Animation] name exist within the player. + Request whether an [Animation] name exist within the player. @@ -2532,7 +2532,7 @@ - Specify a blend time (in seconds) between two animations, referemced by their names. + Specify a blend time (in seconds) between two animations, referenced by their names. @@ -2543,7 +2543,7 @@ - Get the blend time between two animations, referemced by their names. + Get the blend time between two animations, referenced by their names. @@ -2596,7 +2596,7 @@ - Return wether an animation is playing. + Return whether an animation is playing. @@ -3814,7 +3814,7 @@ - This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that repored the entering. + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. @@ -3912,7 +3912,7 @@ - Remove the first occurence of a value from the array. + Remove the first occurrence of a value from the array. @@ -4194,7 +4194,7 @@ - Set the sample data for a given sample as an array of floats. The length must be equal to the sample lenght or an error will be produced. + Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced. For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by [method sample_get_length]. Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data. @@ -4205,7 +4205,7 @@ - Set the sample data for a given sample as an array of bytes. The length must be equal to the sample lenght expected in bytes or an error will be produced. The byte length can be calculated as follows: + Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows: Get the sample length ([method get_sample_length]). If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2. If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. @@ -4381,7 +4381,7 @@ - Set wether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding. + Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding. @@ -4489,7 +4489,7 @@ - Return wether the current voice is positional. See [method voice_set_positional]. + Return whether the current voice is positional. See [method voice_set_positional]. @@ -4618,7 +4618,7 @@ Base class for audio streams. - Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or requiere more flexibility than a [Sample]. + Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a [Sample]. @@ -5166,7 +5166,7 @@ Provides a base class for different kinds of buttons. - BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesnt display anything). Other types of buttons inherit from it. + BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesn't display anything). Other types of buttons inherit from it. @@ -5224,14 +5224,14 @@ - Return wether the button is in disabled state (see [method set_disabled]). + Return whether the button is in disabled state (see [method set_disabled]). - Set the button click_on_press mode. This mode generates click events when a mousebutton or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). + Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). @@ -5245,7 +5245,7 @@ - Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overiding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. + Return 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 DRAW_* enum. @@ -5440,7 +5440,7 @@ - Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hoevered or pressed. + Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed. @@ -5509,7 +5509,7 @@ Array of Buttons. - Array of Buttons. A Button array is useful to have an array of buttons laid out vertically or horizontally. Only one can be selected. This is useful for joypad based interfaces and option menus. + Array of Buttons. A Button array is useful to have an array of buttons laid out vertically or horizontally. Only one can be selected. This is useful for joy pad based interfaces and option menus. @@ -5587,7 +5587,7 @@ - Sekect a button in the array. + Select a button in the array. @@ -5614,7 +5614,7 @@ - Align buttons at the begining. + Align buttons at the beginning. Align buttons in the middle. @@ -5721,7 +5721,7 @@ - Return how a 3D point in worldpsace maps to a 2D coordinate in the [Viewport] rectangle. + Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. @@ -5775,7 +5775,7 @@ - Return wether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). + Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). @@ -6080,7 +6080,7 @@ Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related. - Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significan'tly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrided function, though. + Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significan'tly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though. Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed. @@ -6095,7 +6095,7 @@ - Used for editing, returns an opaque value represeting the transform state. + Used for editing, returns an opaque value representing the transform state. @@ -6509,7 +6509,7 @@ - Emitted when the intem rect has changed. + Emitted when the item rect has changed. @@ -6798,7 +6798,7 @@ Capsule 2D shape resource for physics. - Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modelling biped characters. + Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters. @@ -6948,7 +6948,7 @@ Circular Shape for 2D Physics. - Circular Shape for 2D Physics. This shape is useful for modelling balls or small characters and it's collision detection with everything else is very fast. + Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and it's collision detection with everything else is very fast. @@ -7382,7 +7382,7 @@ Return the index of the first shape generated by the editor. - When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomopsed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]. + When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomposed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]. When [code]build_mode[/code] is set to generate concave polygons, there is only one [Shape2D] generated, so the start index and the end index are the same. @@ -7546,7 +7546,7 @@ - Convert the color to a 32 its integer (each byte represets a RGBA). + Convert the color to a 32 its integer (each byte represents a RGBA). @@ -8105,7 +8105,7 @@ Dialog for confirmation of actions. - Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel buton (in host OS order). + Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order). @@ -8124,8 +8124,8 @@ Base node for containers. - Base node for conainers. A [Container] contains other controls and automatically arranges them in a certain way. - A Control can inherit this to reate custom container classes. + Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way. + A Control can inherit this to create custom container classes. @@ -8146,7 +8146,7 @@ - Enmitted when sorting the children is needed. + Emitted when sorting the children is needed. @@ -8234,7 +8234,7 @@ - Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previos anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin]). + Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin]). @@ -8345,7 +8345,7 @@ - Returns the Control position, relative to the top-left corner of the parent Control and independly of the anchor mode. + Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. @@ -8425,7 +8425,7 @@ - Return wether the Control is the current focused control (see [method set_focus_mode]). + Return whether the Control is the current focused control (see [method set_focus_mode]). @@ -9239,7 +9239,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi Sets the tilt angle in radians for the point "idx". 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 travelling 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. +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. @@ -10333,7 +10333,7 @@ This approximation makes straight segments between each point, then subdivides t Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference. - The effect of these special values uiltimately depends on the low-level implementation of the file format being played. + The effect of these special values ultimately depends on the low-level implementation of the file format being played. @@ -10375,7 +10375,7 @@ This approximation makes straight segments between each point, then subdivides t - Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [method set_volume]) still apply. + Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see [method set_volume]) still apply. @@ -10484,10 +10484,10 @@ This approximation makes straight segments between each point, then subdivides t Driver for MOD playback. - This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events ocurring at defined moments, instead of a stream of audio samples. + This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events occurring at defined moments, instead of a stream of audio samples. Currently, this driver supports the MOD, S3M, IT, and XM formats. This class exposes no methods. - This class can return its playback positon in seconds, but does not allow to set it, failing with only a console warning. + This class can return its playback position in seconds, but does not allow to set it, failing with only a console warning. This class can not return its song length, returning 1.0 when queried. This class does not limit its volume settings, allowing for overflow/distortion and wave inversion. @@ -10929,7 +10929,7 @@ This approximation makes straight segments between each point, then subdivides t Simple Material with a fixed parameter set. - FixedMaterial is a simple type of material [Resource], which contains a fixed amount of paramters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial] for most simple use cases. + FixedMaterial is a simple type of material [Resource], which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial] for most simple use cases. @@ -11253,7 +11253,7 @@ This approximation makes straight segments between each point, then subdivides t - Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies te baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. + Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. @@ -11270,7 +11270,7 @@ This approximation makes straight segments between each point, then subdivides t - Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is apassed. clipping the width. "pos" specifies te 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. + Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is apassed. clipping the width. "pos" 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. @@ -12173,7 +12173,7 @@ This approximation makes straight segments between each point, then subdivides t - Disable input and ouput slot whose index is 'idx'. + Disable input and output slot whose index is 'idx'. @@ -13995,7 +13995,7 @@ returns:= "username=user&password=pass" Mouse button event. - Jostick motion event. + Joystick motion event. Joystick button event. @@ -15651,7 +15651,7 @@ returns:= "username=user&password=pass" - Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Aditionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata]. + Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Additionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata]. @@ -17186,7 +17186,7 @@ returns:= "username=user&password=pass" Special button that brings up a [PopupMenu] when clicked. - Special button that brings up a [PopupMenu] when clicked. That's pretty much all it does, as it's just a helper class when bulding GUIs. + Special button that brings up a [PopupMenu] when clicked. That's pretty much all it does, as it's just a helper class when building GUIs. @@ -17235,7 +17235,7 @@ returns:= "username=user&password=pass" A [Resource] that contains vertex-array based geometry. - Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is prefered to a single surface, because objects created in 3D editing software commonly contain multiple materials. + Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. @@ -17783,7 +17783,7 @@ returns:= "username=user&password=pass" Node that instances meshes into a [Scenario]. - MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current [Scenario] by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a sigle [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. + MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current [Scenario] by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. @@ -17931,12 +17931,12 @@ returns:= "username=user&password=pass" - Provides high perfomance mesh instancing. + Provides high performance mesh instancing. MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. - As a drawback, if the instances are too far away of each other, performance may be reduced as every sigle instance will always rendered (they are spatially indexed as one, for the whole object). + As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [method generate_aabb]. @@ -17958,14 +17958,14 @@ returns:= "username=user&password=pass" - Set the amount of instnces that is going to be drawn. Changing this number will erase all the existing instance transform and color data. + Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. - Return the amount of instnces that is going to be drawn. + Return the amount of instances that is going to be drawn. @@ -18632,12 +18632,12 @@ returns:= "username=user&password=pass" Nodes can be set as children of other nodes, resulting in a tree arrangement. Any tree of nodes is called a "Scene". Scenes can be saved to disk, and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. - [SceneMainLoop] contains the "active" tree of nodes, and a node becomes active (receinving NOTIFICATION_ENTER_SCENE) when added to that tree. - A node can contain any number of nodes as a children (but there is only one tree root) with the requirement that no two childrens with the same name can exist. + [SceneMainLoop] contains the "active" tree of nodes, and a node becomes active (receiving NOTIFICATION_ENTER_SCENE) when added to that tree. + A node can contain any number of nodes as a children (but there is only one tree root) with the requirement that no two children with the same name can exist. Nodes can, optionally, be added to groups. This makes it easy to reach a number of nodes from the code (for example an "enemies" group). Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing ([method _process]) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing ([method _fixed_process]) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. Nodes can also process input events. When set, the [method _input] function will be called with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an [method _unhandled_input] function is called when the input was not handled by anyone else (usually, GUI [Control] nodes). - To keep track of the scene hieararchy (specially when instancing scenes into scenes) an "owner" can be set to a node. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. + To keep track of the scene hierarchy (specially when instancing scenes into scenes) an "owner" can be set to a node. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed, it will free all its children nodes too. @@ -18837,7 +18837,7 @@ returns:= "username=user&password=pass" - Return the absolute path of the current node. This only works if the curent node is inside the scene tree (see [method is_inside_scene]). + Return the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_scene]). @@ -18879,7 +18879,7 @@ returns:= "username=user&password=pass" - Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of chilren nodes may be useful. + Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. @@ -18909,7 +18909,7 @@ returns:= "username=user&password=pass" - Remove a node and set all its children as childrens of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. + Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. @@ -18921,7 +18921,7 @@ returns:= "username=user&password=pass" - Print the screne to stdout. Used mainly for debugging purposes. + Print the scene to stdout. Used mainly for debugging purposes. @@ -18942,21 +18942,21 @@ returns:= "username=user&password=pass" - Notify the current node and all its chldren recursively by calling notification() in all of them. + Notify the current node and all its children recursively by calling notification() in all of them. - Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_time]. + Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_time]. - Return the time elapsed since the last fixed frame. This is always the same in fixed proecssing unless the frames per second is changed in [OS]. + Return the time elapsed since the last fixed frame. This is always the same in fixed processing unless the frames per second is changed in [OS]. @@ -18991,7 +18991,7 @@ returns:= "username=user&password=pass" - Enable input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input (see [method _input]). + Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). @@ -19005,7 +19005,7 @@ returns:= "username=user&password=pass" - Enable unhandled input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]). + Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]). @@ -19156,7 +19156,7 @@ returns:= "username=user&password=pass" Base node for 2D system. - Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierachies for animation and positioning. + Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierarchies for animation and positioning. @@ -19736,7 +19736,7 @@ returns:= "username=user&password=pass" - Return true if an envieronment variable exists. + Return true if an environment variable exists. @@ -20118,7 +20118,7 @@ returns:= "username=user&password=pass" Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [method free] function from the script or delete from C++). - Some derivates add memory management, such as [Reference] (which keps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. + Some derivates add memory management, such as [Reference] (which keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [method _set]. However, scripting languages and C++ have simper means to export them. Objects also receive notifications ([method _notification]). Notifications are a simple way to notify the object about simple events, so they can all be handled together. @@ -20134,7 +20134,7 @@ returns:= "username=user&password=pass" - Return the property list, array of dictionaries, dictionaries must countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). + Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). @@ -20174,7 +20174,7 @@ returns:= "username=user&password=pass" - Check the type of the obeject against a string (including inheritance). + Check the type of the object against a string (including inheritance). @@ -20197,7 +20197,7 @@ returns:= "username=user&password=pass" - Return the list of properties as an array of dictionaries, dictionaries countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). + Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). @@ -20242,7 +20242,7 @@ returns:= "username=user&password=pass" - Set a metadata into the object. Medatada is serialized. Metadata can be [i]anything[/i]. + Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i]. @@ -20265,7 +20265,7 @@ returns:= "username=user&password=pass" - Return the list of metadatas in the object. + Return the list of metadata in the object. @@ -20555,7 +20555,7 @@ returns:= "username=user&password=pass" - OmniDirectional Light, such as a lightbulb or a candle. + OmniDirectional Light, such as a light bulb or a candle. An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of an omnilight. @@ -20906,7 +20906,7 @@ returns:= "username=user&password=pass" Abstraction and base class for packet-based protocols. - PacketPeer is an abstration and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. + PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. @@ -21039,7 +21039,7 @@ returns:= "username=user&password=pass" Provides an opaque background for [Control] children. - Panel is a [Control] that displays an opaque background. It's commoly used as a parent and container for other types of [Control] nodes. [center][img]images/panel_example.png[/img][/center] + Panel is a [Control] that displays an opaque background. It's commonly used as a parent and container for other types of [Control] nodes. [center][img]images/panel_example.png[/img][/center] @@ -22259,7 +22259,7 @@ This method controls whether the position between two cached points is interpola Singleton containing the list of remapped resources. - When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necesary to access to this directly (path remapping happens automatically when opeining a file), it's exported just for information. + When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necessary to access to this directly (path remapping happens automatically when opening a file), it's exported just for information. @@ -22647,11 +22647,11 @@ This method controls whether the position between two cached points is interpola Intersect a ray in a given space, the returned object is a dictionary with the following fields: position: place where ray is stopped. normal: normal of the object at the point where the ray was stopped. - shape: shape index of the object agaisnt which the ray was stopped. - collider_: collider agaisnt which the ray was stopped. - collider_id: collider id of the object agaisnt which the ray was stopped. - collider: collider object agaisnt which the ray was stopped. - rid: [RID] of the object agaisnt which the ray was stopped. + shape: shape index of the object against which the ray was stopped. + collider_: collider against which the ray was stopped. + collider_id: collider id of the object against which the ray was stopped. + collider: collider object against which the ray was stopped. + rid: [RID] of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. @@ -25566,7 +25566,7 @@ This method controls whether the position between two cached points is interpola - Returns true if "point" is inside the plane (by a very minimum treshold). + Returns true if "point" is inside the plane (by a very minimum threshold). @@ -25915,14 +25915,14 @@ This method controls whether the position between two cached points is interpola Base container control for popups and dialogs. - PopUp is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior. + Popup is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior. - Popup (show the control in modal form) in the center of the screen, at the curent size, or at a size determined by "size". + Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". @@ -26003,7 +26003,7 @@ This method controls whether the position between two cached points is interpola - Add a new item with text "label" and icon "texture". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. + Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. @@ -26014,7 +26014,7 @@ This method controls whether the position between two cached points is interpola - Add a new item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. + Add a new item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. @@ -26027,7 +26027,7 @@ This method controls whether the position between two cached points is interpola - Add a new checkable item with text "label" and icon "texture". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Add a new check able item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -26038,7 +26038,7 @@ This method controls whether the position between two cached points is interpola - Add a new checkable item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. @@ -26335,14 +26335,14 @@ This method controls whether the position between two cached points is interpola - Enable the portal (it is enabled by defaul though), disabling it will cause the parent [RoomInstance] to not be visible any longer when looking through the portal. + Enable the portal (it is enabled by default though), disabling it will cause the parent [RoomInstance] to not be visible any longer when looking through the portal. - Return wether the portal is active. When disabled it causes the parent [RoomInstance] to not be visible any longer when looking through the portal. + Return whether the portal is active. When disabled it causes the parent [RoomInstance] to not be visible any longer when looking through the portal. @@ -26598,7 +26598,7 @@ This method controls whether the position between two cached points is interpola - Returns the inverse of the quaternion (applies to the inverse rotatio too). + Returns the inverse of the quaternion (applies to the inverse rotation too). @@ -27172,7 +27172,7 @@ This method controls whether the position between two cached points is interpola Ray 2D shape resource for physics. - Ray 2D shape resource for physics. A ray is not really a collision body, isntead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. + Ray 2D shape resource for physics. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. @@ -27367,7 +27367,7 @@ This method controls whether the position between two cached points is interpola Rectangle Shape for 2D Physics. - Rectangle Shape for 2D Physics. This shape is useful for modelling box-like 2D objects. + Rectangle Shape for 2D Physics. This shape is useful for modeling box-like 2D objects. @@ -27445,12 +27445,12 @@ This method controls whether the position between two cached points is interpola Currently supported features: Capturing [code]()[/code] and non-capturing [code](?:)[/code] groups Any character [code].[/code] - Shorthand caracter classes [code]\w \W \s \S \d \D[/code] + Shorthand character classes [code]\w \W \s \S \d \D[/code] User-defined character classes such as [code][A-Za-z][/code] Simple quantifiers [code]?[/code], [code]*[/code] and [code]+[/code] Range quantifiers [code]{x,y}[/code] Lazy (non-greedy) quantifiers [code]*?[/code] - Begining [code]^[/code] and end [code]$[/code] anchors + Beginning [code]^[/code] and end [code]$[/code] anchors Alternation [code]|[/code] Backreferences [code]\1[/code] and [code]\g{1}[/code] POSIX character classes [code][[:alnum:]][/code] @@ -27559,7 +27559,7 @@ This method controls whether the position between two cached points is interpola Base class for all resources. - Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desred). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. + Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. @@ -27829,7 +27829,7 @@ This method controls whether the position between two cached points is interpola Resource Preloader Node. - Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resourcs are ready to use and be retrieved from here. + Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resources are ready to use and be retrieved from here. @@ -28621,7 +28621,7 @@ This method controls whether the position between two cached points is interpola - Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overriden. + Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden. @@ -28635,7 +28635,7 @@ This method controls whether the position between two cached points is interpola - Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overriden. + Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden. @@ -28720,7 +28720,7 @@ This method controls whether the position between two cached points is interpola Set the continuous collision detection mode from the enum CCD_MODE_*. - Coninuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fat-moving objects. + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fat-moving objects. @@ -30271,7 +30271,7 @@ This method controls whether the position between two cached points is interpola - A helper node for displaying scollable elements (e.g. lists). + A helper node for displaying scrollable elements (e.g. lists). A ScrollContainer node with a [Control] child and scrollbar child ([HScrollbar], [VScrollBar], or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control. @@ -30396,7 +30396,7 @@ This method controls whether the position between two cached points is interpola Base class for separators. - Separator is a [Control] used for sepataring other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. + Separator is a [Control] used for separating other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. @@ -31452,8 +31452,8 @@ This method controls whether the position between two cached points is interpola - Return whether this shape would collide with another, if a given movemen 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 ont the other object ([code]shape_motion[/code]). + Return 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]). @@ -31485,7 +31485,7 @@ This method controls whether the position between two cached points is interpola Return 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 ont the other object ([code]shape_motion[/code]). + 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]). @@ -31497,7 +31497,7 @@ This method controls whether the position between two cached points is interpola Skeleton for characters and animated objects. - Skeleton provides a hierachial interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. + Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. @@ -32126,7 +32126,7 @@ This method controls whether the position between two cached points is interpola - Spatial nodes receive this notifacation with their global transform changes. This means that either the current or a parent node changed its transform. + Spatial nodes receive this notification with their global transform changes. This means that either the current or a parent node changed its transform. @@ -32671,7 +32671,7 @@ This method controls whether the position between two cached points is interpola - Set true to flip the sprite horizontaly. + Set true to flip the sprite horizontally. @@ -33221,7 +33221,7 @@ This method controls whether the position between two cached points is interpola Abstraction and base class for stream-based protocols. - StreamPeer is an abstration and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. + StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. @@ -33230,7 +33230,7 @@ This method controls whether the position between two cached points is interpola - Send a chunk of data through the connection, blocking if necesary until the data is done sending. This function returns an Error code. + Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. @@ -33733,7 +33733,7 @@ This method controls whether the position between two cached points is interpola Built-in string class. - This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necesary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. + This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. @@ -33777,7 +33777,7 @@ This method controls whether the position between two cached points is interpola - Perform a case-sensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater. + Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. @@ -33802,7 +33802,7 @@ This method controls whether the position between two cached points is interpola - Find the first occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. @@ -33811,7 +33811,7 @@ This method controls whether the position between two cached points is interpola - Find the last occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. @@ -33822,7 +33822,7 @@ This method controls whether the position between two cached points is interpola - Find the first occurence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. @@ -33970,7 +33970,7 @@ This method controls whether the position between two cached points is interpola - Perform a case-insensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater. + Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. @@ -34048,7 +34048,7 @@ This method controls whether the position between two cached points is interpola - Perform a search for a substring, but start from the end of the string instead of the begining. + Perform a search for a substring, but start from the end of the string instead of the beginning. @@ -34059,7 +34059,7 @@ This method controls whether the position between two cached points is interpola - Perform a search for a substring, but start from the end of the string instead of the begining. Also search case-insensitive. + Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. @@ -34097,7 +34097,7 @@ This method controls whether the position between two cached points is interpola - Return a copy of the string stripped of any non-printable character at the begining and the end. + Return a copy of the string stripped of any non-printable character at the beginning and the end. @@ -34233,7 +34233,7 @@ This method controls whether the position between two cached points is interpola - Test a position in a rectangle, return wether it pases the mask test. + Test a position in a rectangle, return whether it passes the mask test. @@ -34396,7 +34396,7 @@ This method controls whether the position between two cached points is interpola Image mask based StyleBox, for mask test. - This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the poit clicked is masked or not. + This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the point clicked is masked or not. @@ -34424,7 +34424,7 @@ This method controls whether the position between two cached points is interpola - Return wether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. + Return whether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. @@ -34739,7 +34739,7 @@ This method controls whether the position between two cached points is interpola - Set a title for the tab. Tab titles are by default the children node name, but this can be overriden. + Set a title for the tab. Tab titles are by default the children node name, but this can be overridden. @@ -34748,7 +34748,7 @@ This method controls whether the position between two cached points is interpola - Return the title for the tab. Tab titles are by default the children node name, but this can be overriden. + Return the title for the tab. Tab titles are by default the children node name, but this can be overridden. @@ -35292,7 +35292,7 @@ This method controls whether the position between two cached points is interpola Match whole words when searching. - Search from end to begining. + Search from end to beginning. @@ -39458,7 +39458,7 @@ This method controls whether the position between two cached points is interpola - Return the final, visuble rect in global screen coordinates. + Return the final, visible rect in global screen coordinates. @@ -39472,7 +39472,7 @@ This method controls whether the position between two cached points is interpola - Reurn whether the viewport lets whatever is behind it to show. + Return whether the viewport lets whatever is behind it to show.